Install

NamiDB ships in four flavours, all driven by the same Rust core.

Python

Pre-built wheels (abi3) for Python ≥ 3.9 on Linux (x86_64 + aarch64), macOS (arm64), and Windows (x86_64). Intel macOS falls back to sdist.

pip install namidb                # core
pip install 'namidb[pandas]'      # + DataFrame interop
pip install 'namidb[polars]'      # + Polars interop

pyarrow >= 14 is a hard transitive dependency.

From source

pip install maturin
git clone https://github.com/namidb/namidb.git
cd namidb/crates/namidb-py
maturin develop --release --extras test

→ Full Python SDK reference

Rust (embedded)

Add the umbrella crate to your Cargo.toml:

[dependencies]
namidb = "0.3"
tokio = { version = "1", features = ["full"] }

MSRV is Rust 1.85. The workspace exposes a stable facade crate so downstream code only needs one line.

→ Full Rust SDK reference

CLI

From source (one-shot install):

git clone https://github.com/namidb/namidb.git
cd namidb
cargo install --path crates/namidb-cli

namidb run "CREATE (a:Person {name: 'Alice'})"
namidb run --store s3://my-bucket?ns=prod \
  "MATCH (p:Person) RETURN count(*) AS n"
namidb explain --verbose \
  "MATCH (a:Person)-[:KNOWS]->(b) RETURN b ORDER BY b.id LIMIT 20"

→ Full CLI reference

HTTP server (namidb-server)

Cargo

cargo install --path crates/namidb-server

Docker

docker build -t namidb-server:0.3 \
  -f crates/namidb-server/Dockerfile .

Run it:

namidb-server \
  --store 's3://my-bucket?ns=prod&region=us-east-1' \
  --listen 0.0.0.0:8080 \
  --auth-token "$NAMIDB_AUTH_TOKEN" \
  --flush-interval 30s

Every flag is also an env var: NAMIDB_STORE, NAMIDB_LISTEN, NAMIDB_AUTH_TOKEN, NAMIDB_FLUSH_INTERVAL.

No token, no production

If --auth-token is unset, the server boots in unauthenticated mode and prints a loud warning. Do not expose that port to the public internet.

→ Full HTTP API reference · → Self-host with Docker Compose

Verify the install

Python

import namidb as tg
client = tg.Client("memory://test")
print(client.cypher("RETURN 1 AS n").rows())
# [{'n': 1}]

CLI

namidb run "RETURN 1 AS n"

HTTP

namidb-server --store memory://test --listen 127.0.0.1:8080 &
curl -s http://127.0.0.1:8080/v0/health | jq .

Supported platforms

Surface	Linux x86_64	Linux aarch64	macOS arm64	macOS x86_64	Windows x86_64
Python wheel	✅	✅	✅	sdist	✅
Rust crate	✅	✅	✅	✅	✅
namidb-server binary	✅	✅	✅	✅	✅
Docker image	✅ (multi-arch)	✅ (multi-arch)	—	—	—