https://github.com/surrealdb/surrealdb.node

A Node.js engine for the SurrealDB JavaScript SDK
https://github.com/surrealdb/surrealdb.node

database database-connector iot-database javascript javascript-library node-library node-module nodejs realtime-database surreal surrealdb typescript

Last synced: 3 months ago
JSON representation

A Node.js engine for the SurrealDB JavaScript SDK

• Host: GitHub
• URL: https://github.com/surrealdb/surrealdb.node
• Owner: surrealdb
• License: apache-2.0
• Created: 2022-04-07T16:16:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T13:12:51.000Z (3 months ago)
• Last Synced: 2024-08-01T14:43:02.618Z (3 months ago)
• Topics: database, database-connector, iot-database, javascript, javascript-library, node-library, node-module, nodejs, realtime-database, surreal, surrealdb, typescript
• Language: Rust
• Homepage: https://surrealdb.com
• Size: 1.11 MB
• Stars: 53
• Watchers: 17
• Forks: 9
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-surreal - surrealdb.node - <a href="https://surrealdb.com#gh-dark-mode-only" target="_blank"><img src="/img/white/text.svg" height="12" alt="SurrealDB"></a> <a href="https://surrealdb.com#gh-light-mode-only" target="_blank"><img src="/img/black/text.svg" height="12" alt="SurrealDB"></a> official driver for Node.js. (Client libraries)

README

        





    

     

    



A Node.js engine for the SurrealDB JavaScript SDK.







    

     

    

     

    





    

     

    

     

    

     

    



# surrealdb.node

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

This library is a plugin for the SurrealDB JavaScript SDK, which can be used to run SurrealDB as an embedded database within a Node.js 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 'surrealdb.js';

import { surrealdbNodeEngines } from 'surrealdb.node';

// Enable the WebAssembly engines

const db = new Surreal({

    engines: surrealdbNodeEngines(),

});

// 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.

```