SurrealDB JavaScript SDK

The official SDK (surrealdb on npm) works in Node.js, Deno, Bun, and the browser. It connects to a remote SurrealDB instance over WebSocket/HTTP, or runs an embedded engine in-process. Target the latest stable surrealdb release; install without pinning (npm i surrealdb) unless the user requires a specific version.

Installation

npm i surrealdb
# or: pnpm i surrealdb / yarn add surrealdb / bun add surrealdb

Connect & select namespace/database

Always connect, then use a namespace + database, then authenticate. Close the connection when finished.