Repository files navigation

A Deno engine for the SurrealDBJavaScript SDK.

This library is under active development and is not yet released.

This library is a plugin for the SurrealDB JavaScript SDK, which can be used to run SurrealDB as an embedded database within a Deno server side environment.

It enables SurrealDB to be run in-memory, or to persist data by running on top of SurrealKV. It allows for a consistent JavaScript and TypeScript API when using thesurrealdb.js library by adding support for embedded storage engines (memory,surrealkv) alongside the remote connection protocols (http,https,ws,wss).

importSurrealfrom"https://deno.land/x/surrealdb/mod.ts";import{surrealdbDenoEngines}from"https://deno.land/x/surrealdb.deno/mod.ts";// Enable the WebAssembly enginesconstdb=newSurreal({engines:surrealdbDenoEngines(),});// Now we can start SurrealDB as an in-memory databaseawaitdb.connect("mem://");// Or we can start a persisted SurrealKV databaseawaitdb.connect("surrealkv://demo");// Now use the JavaScript SDK as normal.