API Reference

Complete API documentation for all NebulaDB components and methods.

Core API

createDb(options)

Creates a new database instance.

Parameters:

• options: DbOptions — Configuration options
  • adapter: Adapter — Storage adapter to use
  • plugins?: Plugin[] — Optional array of plugins

Returns: IDatabase

import { createDb } from '@nebula-db/core';
import { MemoryAdapter } from '@nebula-db/adapter-memory';

const db = createDb({ adapter: new MemoryAdapter() });

IDatabase

Properties:

• collections: Map<string, ICollection>
• adapter: Adapter
• plugins: Plugin[]

Methods:

• collection(name: string, options?: CollectionOptions): ICollection — Get or create a collection
• save(): Promise<void> — Save database state

ICollection

Methods:

• insert(doc): Promise<Document> — Insert a document
• find(query?): Promise<Document[]> — Find matching documents
• findOne(query): Promise<Document | null> — Find single document
• update(query, update): Promise<number> — Update matching documents
• delete(query): Promise<number> — Delete matching documents
• subscribe(query, callback): () => void — Subscribe to changes

Query Operators

Comparison

Operator	Description
$eq	Equal to
$ne	Not equal to
$gt	Greater than
$gte	Greater than or equal
$lt	Less than
$lte	Less than or equal
$in	In array
$nin	Not in array
$regex	Regular expression
$exists	Field exists

// Equal to (shorthand)
await collection.find({ age: 30 });

// Greater than
await collection.find({ age: { $gt: 25 } });

// In array
await collection.find({ status: { $in: ['active', 'pending'] } });

Logical

Operator	Description
$and	Logical AND
$or	Logical OR
$not	Logical NOT

// AND
await collection.find({ $and: [{ age: { $gt: 25 } }, { status: 'active' }] });

// OR
await collection.find({ $or: [{ status: 'active' }, { age: { $gt: 30 } }] });

Update Operators

Operator	Description
$set	Set field values
$unset	Remove fields
$inc	Increment numeric fields
$push	Add items to arrays
$pull	Remove items from arrays

// Set fields
await collection.update({ id: '1' }, { $set: { name: 'New Name', age: 31 } });

// Increment
await collection.update({ id: '1' }, { $inc: { age: 1, count: 5 } });

// Push to array
await collection.update({ id: '1' }, { $push: { tags: 'new-tag' } });

Types

Document

type Document = { id: string; [key: string]: any; };

Query

type Query = { [key: string]: any | QueryCondition; } | LogicalQuery;

DbOptions

interface DbOptions { adapter: Adapter; plugins?: Plugin[]; }

Adapter

interface Adapter {
  load(): Promise<Record<string, Document[]>>;
  save(data: Record<string, Document[]>): Promise<void>;
  connect?(): Promise<void>;
  close?(): Promise<void>;
}