Node.js

@nuventra/nuvexadb-node loads the C ABI with koffi. NUVEXA_NATIVE_LIB is required.

From NuvexaDB v1.0.6:

Inside the Node zip: nuventra-nuvexadb-node-1.0.6.tgz (npm pack of @nuventra/nuvexadb-node).

This is the desktop Node SDK. For React Native apps see react-native.md.

mkdir acme-store && cd acme-store
npm init -y

Use "type": "module" in package.json (the SDK is ESM).

npm install /path/to/nuventra-nuvexadb-node-1.0.6.tgz
export NUVEXA_NATIVE_LIB="/absolute/path/to/libnuvexa.dylib"

Windows:

$env:NUVEXA_NATIVE_LIB = "C:\path\to\nuvexa.dll"

import { NuvexaDatabase } from "@nuventra/nuvexadb-node";

const path = "app.nvx";
const db = await NuvexaDatabase.create(path, key); // omit key / pass null for plaintext
await db.close();

if ((await NuvexaDatabase.isEncrypted(path)) && !key) {
  throw new Error("Encrypted .nvx — pass the key");
}
const opened = await NuvexaDatabase.open(path, key);
await opened.close();

import { unlink } from "node:fs/promises";

await db.close();
await unlink(path);
await unlink(path + "-wal").catch(() => {});

await db.insert("users", JSON.stringify({ name: "Ada", age: 36 }));
console.log(await db.listCollections());
await db.renameCollection("users", "people");
await db.dropCollection("people");

const id = await db.insert("users", JSON.stringify({ name: "Ada", age: 36 }));
await db.insertMany("users", JSON.stringify([{ name: "Grace", age: 85 }]));
const ada = await db.findById("users", id);
await db.replace("users", JSON.stringify({ _id: id, name: "Ada Lovelace", age: 36 }));
await db.deleteById("users", id);
const rows = await db.execute("db.users.find({ age: { $gte: 21 } }).limit(20)");

Read the key from the environment or a secret manager. Do not commit it. 1234 is a local demo only.

await db.changeEncryptionKey(currentKey, nextKey);

See Encryption notes.