Embedded (@liorandb/core)

📄️Getting started

LioranDB Embedded is a file-based JSON document database for Node.js (backed by a write-ahead log).

LioranManager is the top-level object you create in your app. It owns:

LioranDB represents a single database directory under the manager root.

A Collection stores JSON documents keyed by _id (string). It's the API you'll use most: insert, query, update, delete, aggregate.

LioranDB's embedded query engine uses plain JavaScript objects.

Indexes are created per collection field and are persisted on disk. They speed up queries like:

Transactions group multiple operations into a single atomic commit (WAL-backed).

Migrations exist at two levels:

@liorandb/core can run in a multi-node cluster topology (advanced).

Snapshots are created/restored by the LioranManager.

Compaction rebuilds collection storage to remove fragmentation and then rebuilds indexes.

Replication is configured through LioranManagerOptions.replication (advanced).

Consistency is configured through LioranManagerOptions.consistency (advanced).

LioranDB encrypts documents at rest when an encryption key is configured on the manager.

LioranManager supports multiple process modes so you can safely use one database root from multiple Node processes.

Tenancy is configured through LioranManagerOptions.tenancy (advanced).

Key limits

Security hooks are configured through LioranManagerOptions.security (advanced).

@liorandb/core uses a single "root folder" where all database directories are stored.