dbx-native
v0.2.0-beta
Published
DBX native Node.js bindings using napi-rs
Maintainers
Readme
dbx-native
High-performance Node.js bindings for DBX embedded database
dbx-native provides native Node.js bindings to the DBX database engine via N-API, delivering near-zero overhead access to the high-performance Rust core.
Installation
npm install dbx-nativeQuick Start
const dbx = require('dbx-native');
// Open an in-memory database
const db = dbx.openInMemory();
// Insert data
db.insert('users', Buffer.from('user:1'), Buffer.from('Alice'));
db.insert('users', Buffer.from('user:2'), Buffer.from('Bob'));
// Get data
const value = db.get('users', Buffer.from('user:1'));
console.log(value.toString()); // Alice
// Delete data
db.delete('users', Buffer.from('user:2'));
// Close database
db.close();SQL Interface
const dbx = require('dbx-native');
const db = dbx.openInMemory();
// Execute SQL
db.executeSql('CREATE TABLE users (id INTEGER, name TEXT)');
db.executeSql("INSERT INTO users VALUES (1, 'Alice')");
const result = db.executeSql('SELECT * FROM users');
console.log(result);
db.close();API Reference
| Method | Description |
|--------|-------------|
| openInMemory() | Open an in-memory database |
| open(path) | Open a file-based database |
| insert(table, key, value) | Insert a key-value pair |
| get(table, key) | Get value by key |
| delete(table, key) | Delete a key |
| executeSql(sql) | Execute a SQL statement |
| close() | Close and free resources |
Benchmarks
npm run benchRequirements
- Node.js 18+
- Windows x64 (native addon included)
License
Dual-licensed under:
- MIT License — for open-source projects
- Commercial License — for proprietary/commercial use
See LICENSE for details.
For commercial licensing inquiries, contact: ByteLogicCore
