A lightweight and fast queue database server with WebSocket support for real-time data streaming
npm install queuedbQDB is a lightweight, local-first Real-time Queuing Database designed to be a "Firebase-lite" for your Node.js projects. It combines a JSON-based database, a robust job queue, real-time WebSocket subscriptions, and an admin UI into a single zero-dependency (almost) package.
- Store: Simple JSON-based tables with SQL-like queries (powered by SQLite).
- Queue: Built-in job queue with atomic enqueue, dequeue, ack, and fail operations.
- Real-time: WebSocket subscriptions to tables or specific topics. No polling required.
- Data Lifetime: Auto-expire data with a built-in TTL system.
- Migration: Tools to migrate schema and archive old data to keep things fast.
- UI Hosting: Serve your own React-based Admin UI directly from the database server.
- CLI: Native CLI for management (qdb init, qdb migrate, qdb start).
``bash`
npm install queuedb
Initialize and run QDB in seconds:
`bashInitialize a new database
npx qdb init my_project
Core Usage (SDK)
typescript
import { QDB, QDBServer } from 'queuedb';// 1. Setup Database
const db = new QDB("my_project", {});
await db.init(); // Creates tables and queue system
// 2. Queue Operations
await db.enqueue('email_notifications', { userId: 1, type: 'welcome' });
// 3. Worker / Consumer
const job = await db.dequeue('worker_client_1');
if (job.success && job.data) {
console.log("Processing:", job.data);
// ... work ...
await db.ack(job.data.id);
}
// 4. Start Server for Realtime Access
const server = new QDBServer("main", { port: 3000 });
server.mountDb(db);
server.listen();
`Real-time Subscriptions (WebSocket)
Clients can connect via WebSocket to receive updates instantly.
Connect:
Subscribe:
Send a JSON message:
json
{
"type": "subscribe",
"method": "GET",
"route": "/my_project/users"
}
`Receive Updates:
You will receive a message whenever data changes in the subscribed route.
Admin UI
QDB can host a web-based Admin UI (e.g., a React app).
By default, the middleware serves files from
at the /admin route.CLI Commands
-
qdb init : Create new DB structure.
- qdb start : Start the QDB server.
- qdb migrate : Run schema migrations.
- qdb archive