SurrealDB

SurrealDB is a multi-model database (document + graph + SQL-like queries). The Primate driver can connect to a remote server or run an embedded, in-memory engine via Surreal's WASM Node runtime.

Setup

Install

npm install @primate/surrealdb

If you point the driver to a running SurrealDB server, have it installed and running. If you leave the connection unset, the driver runs embedded (in-memory).

Configure

// config/database/index.ts
import surrealdb from "@primate/surrealdb";

export default surrealdb({
  database: "app",
  // Remote server (uncomment to use a DBMS):
  // host: "http://localhost",
  // port: 8000,
  // path: "/rpc",
  // namespace: "main",
  // username: "root",
  // password: "secret",
});

Options