Developers / getting started

The shortest path from an empty folder to a document query.

Start with the documented local Docker path, install the official JavaScript or TypeScript driver, then use the maintained docs for authentication, CLI, API, and deployment details.

Open documentation Browse drivers

01 · Run

Start a local node

Use the Docker command maintained in the official docs and mount a persistent data volume.

docker run -d --name liorandb -p 27018:27018 -p 27019:27019 -p 27201:27201 -v ldb-data:/var/lib/liorandb/data liorandb/liorandb:pre-alpha

02 · Install

Add the client

Official SDK support currently covers JavaScript and TypeScript through the @liorandb/driver package.

npm install @liorandb/driver

03 · Connect

Write one query

Keep credentials in environment variables and use the docs for auth and URI details.

Connection guide

JavaScript / TypeScript

The documented API shape.

This example follows the official docs and uses a placeholder URI. Replace it with the credentials and endpoint provided by your deployment.

import { LioranDBClient } from "@liorandb/driver";

const client = await LioranDBClient.connect(
  process.env.LIORANDB_URI ??
    "liorandb://admin:password@127.0.0.1:27018/default",
);

try {
  const users = client.db("default").collection("users");
  await users.insertOne({ email: "ada@example.com", active: true, age: 31 });
  const user = await users.findOne({ email: "ada@example.com" });
  console.log(user);
} finally {
  await client.close();
}

Developer safety

Local defaults are not production posture.

Secrets

Use environment variables, secret managers, and TLS-aware connection settings for shared environments.

Durability

WAL and checkpointing do not automatically describe fsync-per-write guarantees. Verify acknowledgement semantics.

Capacity

Treat local benchmark measurements and managed plan limits as separate pieces of information.