Skip to main content

LioranDB Docs

LioranDB is a lightweight database ecosystem:

  • Embedded database for Node.js scripts and apps: npm i @liorandb/core
  • Server + CLI (optional) for HTTP access and user management: npm i -g @liorandb/db
  • HTTP driver (Node.js/TypeScript) for apps that talk to the server: npm i @liorandb/driver
  • HTTP driver (Python) for apps that talk to the server: pip install liorandb-driver

All packages ship with TypeScript types.

Where to start

  • If you want embedded, file-based DB (no server, no CLI): go to Embedded -> Getting started (1 minute)
  • If you want an HTTP server: go to Server & CLI -> Server quickstart
  • If you want a client SDK: go to Driver -> Getting started

Package map

  • @liorandb/core: embedded DB engine + encryption + indexing + WAL recovery
  • @liorandb/db: server + CLI (ldb-serve, ldb-cli, ldb-users, and ldb)
  • @liorandb/driver: HTTP client + typed DB/Collection wrappers (+ optional LioranManager facade)

Supported languages

Driver code samples are provided for TypeScript, JavaScript, and Python (where applicable). Use the tabs in each section to switch and copy/paste.