relbyte

A tiny portable relational database built on bytes.

relbyte is the umbrella package for the Relbyte relational database engine. It includes:

• @relbyte/core — Binary page-based relational storage engine & B+Tree indexer
• @relbyte/cli — CLI tool (relbyte)

Installation

npm install relbyte

Quick Start (Embedded Database)

import { Relbyte } from 'relbyte';

const db = await Relbyte.open('./app.relbyte', { durability: 'balanced' });

const users = await db.createTable('users', {
  id: { type: 'uint32', primaryKey: true },
  name: { type: 'string' },
  score: { type: 'float64' },
});

await users.insert({ id: 1, name: 'Alice', score: 98.5 });
const user = await users.get(1);
console.log(user);

await db.close();

Command Line Interface (CLI)

# Using npx without local install
npx relbyte --help

# Or install globally
npm install -g relbyte
relbyte --help

Individual Packages

If you only need specific components, install them individually:

• @relbyte/core — Engine & B+Tree only (zero dependencies)
• @relbyte/cli — CLI commands
• @relbyte/http — Remote Hono HTTP server
• @relbyte/client — Lightweight typed client
• @relbyte/ui — Web database studio
• @relbyte/testing — Test utilities

License

MIT