surrealdb.js

The official SurrealDB library for JavaScript.

Quickstart-Guide

Install

Deno

Import it with

import Surreal from "https://deno.land/x/surrealdb/mod.ts";

Note you should set a version in the url! For example https://deno.land/x/[email protected]/mod.ts

NodeJS, or browser with a bundler

For NodeJS or a browser with bundler (for example: rollup, vite, or webpack) you can just: install the npm package:

npm i surrealdb.js
# or with yarn
yarn add surrealdb.js
# or with pnpm
pnpm i surrealdb.js

then, just import it with:

import Surreal from "surrealdb.js";

or when you use CommonJS

const { Surreal } = require("surrealdb.js");

CDN for Browser

For fast prototyping we provide a browser-ready bundle. You can import it with

import Surreal from "https://unpkg.com/surrealdb.js";
// or
import Surreal from "https://cdn.jsdelivr.net/npm/surrealdb.js";

NOTE: this bundle is not optimized for production! So don't use it in production!

Getting started

Here you have a simple example!

This example uses top level await wich is available in deno, node >= 14.8, modern browsers (https://caniuse.com/mdn-javascript_operators_await_top_level).

import { Surreal, RecordId, Table } from "surrealdb.js";

const db = new Surreal();

// Connect to the database
await db.connect("http://127.0.0.1:8000/rpc");

// Signin as a namespace, database, or root user
await db.signin({
	username: "root",
	password: "root",
});

// Select a specific namespace / database
await db.use({ 
	namespace: "test", 
	database: "test" 
});

// Create a new person with a random id
let created = await db.create("person", {
	title: "Founder & CEO",
	name: {
		first: "Tobie",
		last: "Morgan Hitchcock",
	},
	marketing: true,
});

// Update a person record with a specific id
let updated = await db.merge(new RecordId('person', 'jaime'), {
	marketing: true,
});

// Select all people records
let people = await db.select("person");

// Perform a custom advanced query
let groups = await db.query(
	"SELECT marketing, count() FROM $tb GROUP BY marketing",
	{
		tb: new Table("person"),
	},
);

More informations

The docs of this libary are located at https://surrealdb.com/docs/integration/libraries/javascript

Contribution notes

Local setup

This is a Deno project, not NodeJS. For example, this means import paths include the .ts file extension. However, to also support other JavaScript environments, a build has been added to create a npm package that works for NodeJS, Bun, browsers with bundlers.

Supported environments

• Deno
• NodeJS
• Bun
• Web Browsers

Requirements

• Deno
• SurrealDB (for testing)

Build for all supported environments

For Deno, no build is needed. For all other environments run

deno task build.

Formatting

deno fmt

Linting

deno lint

Run tests

deno test --allow-net --allow-run --trace-leaks

PRs

Before you commit, please format and lint your code accordingly to check for errors, and ensure all tests still pass

Local setup

For local development the Deno extension for VSCode is helpful (hint: local Deno installation required).

Directory structure

• ./mod.ts is the deno entypoint. This is just a reexport of ./src/index.ts
• ./deno.json include settings for linting, formatting and testing.
• ./compile.ts include the build script for the npm package.
• ./src includes all source code. ./src/index.ts is the main entrypoint.
• ./npm is build by ./compile.ts and includes the generated npm package.
• ./tests includes all test files.