stratadb / Strata

Class: Strata

Defined in: src/stratadb.ts:53

Main StrataDB database class.

Remarks

StrataDB provides a MongoDB-like document database API backed by SQLite. It manages collections, transactions, and database lifecycle.

Features:

• Type-safe document operations
• JSONB storage with indexed generated columns
• Transaction support with automatic rollback
• Symbol.dispose for automatic cleanup

Example

// Create database with path
const db = new Strata({ database: 'myapp.db' });

// Create in-memory database
const memDb = new Strata({ database: ':memory:' });

// With custom options
const customDb = new Strata({
  database: 'app.db',
  idGenerator: () => `custom-${Date.now()}`,
  onClose: () => console.log('Database closed'),
  debug: true
});

// Using with automatic cleanup
using db = new Strata({ database: ':memory:' });
const users = db.collection('users', userSchema);
// Database automatically closes when scope exits

Implements

• StrataDB

Constructors

Constructor

new Strata(options): Strata;

Defined in: src/stratadb.ts:66

Creates a new StrataDB instance.

Parameters

options

DatabaseOptions

Database configuration options

Returns

Strata

Properties

sqliteDb

readonly sqliteDb: Database;

Defined in: src/stratadb.ts:54

Direct access to the underlying SQLite database. Use for advanced operations not covered by StrataDB API.

Implementation of

StrataDBInterface.sqliteDb

Methods

[dispose]()

dispose: void;

Defined in: src/stratadb.ts:206

Disposes the database (closes connection).

Returns

void

Implementation of

StrataDBInterface.[dispose]

---

close()

close(): void;

Defined in: src/stratadb.ts:198

Closes the database connection.

Returns

void

Implementation of

StrataDBInterface.close

---

collection()

Implementation of overloaded collection method.

Call Signature

collection<T>(
   name, 
   schema, 
options?): Collection<T>;

Defined in: src/stratadb.ts:91

Gets or creates a collection with a pre-built schema.

Type Parameters

T

T extends Document

Parameters

name

string

schema

SchemaDefinition<T>

options?

CollectionOptions

Returns

Collection<T>

Implementation of

StrataDBInterface.collection

Call Signature

collection<T>(name): CollectionBuilder<T>;

Defined in: src/stratadb.ts:100

Creates a collection builder for fluent schema definition.

Type Parameters

T

T extends Document

Parameters

name

string

Returns

CollectionBuilder<T>

Implementation of

StrataDBInterface.collection

---

execute()

execute<R>(fn): Promise<R>;

Defined in: src/stratadb.ts:183

Executes a function within a transaction.

Type Parameters

R

R

Parameters

fn

(tx) => R | Promise<R>

Function to execute

Returns

Promise<R>

Result of the function

Implementation of

StrataDBInterface.execute

---

generateId()

generateId(): string;

Defined in: src/stratadb.ts:84

Generates a new unique ID using the configured ID generator.

Returns

string

A new unique identifier string

Implementation of

StrataDBInterface.generateId

---

transaction()

transaction(): Transaction;

Defined in: src/stratadb.ts:145

Creates a new transaction.

Returns

Transaction

Transaction instance

Implementation of

StrataDBInterface.transaction