@alcalzone/jsonl-db

jsonl-db

Simple JSONL-based key-value store. Uses an append-only file to store the data. With support for database dumps and compressing the db file.

Usage

Load the module:

import { DB } from "@alcalzone/jsonl-db";

Open or create a database file:

const db = new DB("/path/to/file");
await db.open();

Use the database like you would use a Map.

The data is persisted asynchronously, so make sure to close() the DB when you no longer need it:

await db.close();

To create a compressed copy of the database in /path/to/file.dump, use the dump() method. If any data is written to the db during the dump, it is appended to the dump but most likely compressed.

await db.dump();

After a while, the main db file may contain unnecessary entries. To remove them, use the compress() method.

await db.compress();

Note: During this call, /path/to/file.dump is overwritten and then renamed, /path/to/file.bak is overwritten and then deleted. So make sure you don't have any important data in these files.

Changelog

0.1.3 (2020-04-25)

• Writes that happen while compress() replaces files are now persisted

0.1.2 (2020-04-25)

• compress() no longer overwrites the main file while the DB is being closed

0.1.1 (2020-04-25)

• Fixed some race conditions

0.1.0 (2020-04-25)

First official release