Quick Start

Get started with DBX in 5 minutes!

Installation

npm install dbx-py

First Program

import { Database } from 'dbx-py';

// Open in-memory database
const db = Database.openInMemory();

// KV operations
db.insert('users', Buffer.from('user:1'), Buffer.from('Alice'));
const value = db.get('users', Buffer.from('user:1'));
console.log(value?.toString());  // Alice

// SQL operations
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();

TypeScript Usage

interface User {
  id: number;
  name: string;
  email: string;
}

const db = Database.open('mydb.db');

// Store JSON
const user: User = { id: 1, name: 'Alice', email: 'alice@example.com' };
db.insert('users', Buffer.from('user:1'), Buffer.from(JSON.stringify(user)));

// Retrieve JSON
const data = db.get('users', Buffer.from('user:1'));
if (data) {
  const user: User = JSON.parse(data.toString());
  console.log(user.name);
}

db.close();

Next Steps

• SQL Guide - SQL usage
• KV Operations - Key-Value operations
• API Reference - Complete API