Skip to main content
Version: v0.3.0

Quickstart

Prerequisites​

  • Zig 0.15.x (recommended: use the pinned toolchain via Nix; see below)

Build​

From the repo root:

zig build

The binary is emitted at ./zig-out/bin/sydradb.

Run the HTTP server​

By default, sydradb runs the HTTP server (equivalent to serve):

./zig-out/bin/sydradb

The server loads ./sydradb.toml from the current working directory. If the file is missing, it falls back to built-in defaults.

Important: the current config loader is a minimal parser and does not reliably support inline comments (for example auth_token = "" # ...). If the server appears to ignore your config or fails to parse it, remove inline comments.

See:

Ingest a point​

The HTTP ingest endpoint accepts NDJSON (one JSON object per line):

curl -XPOST localhost:8080/api/v1/ingest --data-binary $'{"series":"weather.room1","ts":1694300000,"value":24.2}\\n'

See: HTTP API – POST /api/v1/ingest.

Query a range​

curl -XPOST localhost:8080/api/v1/query/range \\
  --data-binary '{"series":"weather.room1","start":1694290000,"end":1694310000}'

See: HTTP API – POST /api/v1/query/range.

Nix (pinned toolchain)​

nix develop
zig build

To build a reproducible package:

nix build
./result/bin/sydradb

See also: