The @surrealdb/node package is a plugin for the JavaScript SDK that runs SurrealDB as an embedded database within Node.js, Bun, or Deno. It supports in-memory databases and persistent storage via RocksDB and SurrealKV.

Installation

First, install the JavaScript SDK if you haven't already. Then add the Node.js engine:

npm install --save @surrealdb/node

yarn add @surrealdb/node

pnpm install @surrealdb/node

Quick start

import { Surreal, createRemoteEngines } from 'surrealdb';
import { createNodeEngines } from '@surrealdb/node';

const db = new Surreal({
    engines: {
        ...createRemoteEngines(),
        ...createNodeEngines(),
    },
});

await db.connect('mem://');

// Always close the connection when done
await db.close();

Learn more

• Connecting to SurrealDB for engine registration, embedded protocols, and connection options

• @surrealdb/node on npm