https://github.com/surrealdb/surrealdb.deno

A Deno engine for the SurrealDB JavaScript SDK
https://github.com/surrealdb/surrealdb.deno

database database-connector deno deno-library deno-module iot-database javascript javascript-library realtime-database surreal surrealdb typescript

Last synced: 3 months ago
JSON representation

A Deno engine for the SurrealDB JavaScript SDK

• Host: GitHub
• URL: https://github.com/surrealdb/surrealdb.deno
• Owner: surrealdb
• License: apache-2.0
• Created: 2022-04-07T16:17:05.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-01T10:29:25.000Z (7 months ago)
• Last Synced: 2025-06-30T07:19:05.489Z (4 months ago)
• Topics: database, database-connector, deno, deno-library, deno-module, iot-database, javascript, javascript-library, realtime-database, surreal, surrealdb, typescript
• Language: TypeScript
• Homepage: https://surrealdb.com
• Size: 20.5 KB
• Stars: 14
• Watchers: 12
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          





    

     

    



A Deno engine for the SurrealDB JavaScript SDK.







    

     

    

     

    





    

     

    

     

    

     

    



# surrealdb.deno

A Deno engine for the SurrealDB [JavaScript SDK](https://github.com/surrealdb/surrealdb.js).

> [!WARNING]

> 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 the `surrealdb.js` library by adding support for embedded storage engines (`memory`, `surrealkv`) alongside the remote connection protocols (`http`, `https`, `ws`, `wss`).

## Example usage

```js

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

import { surrealdbDenoEngines } from "https://deno.land/x/surrealdb.deno/mod.ts";

// Enable the WebAssembly engines

const db = new Surreal({

    engines: surrealdbDenoEngines(),

});

// Now we can start SurrealDB as an in-memory database

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

// Or we can start a persisted SurrealKV database

await db.connect("surrealkv://demo");

// Now use the JavaScript SDK as normal.

```