KalamDB Documentation

KalamDB docs are organized by the part of the stack you are working with. Start with the server docs for running KalamDB and SQL, then jump into an SDK, a PostgreSQL extension, or implementation patterns.

Choose A Docs Area

• Server: run KalamDB, configure auth, use SQL, operate storage, and deploy production services.
• CLI: install kalam, scaffold and run a local app with kalam init + kalam dev, manage migrations, and use the SQL client.
• pg_kalam PostgreSQL Extension: connect PostgreSQL to KalamDB through the pg_kalam extension.
• pg Koldstore: tier hot PostgreSQL rows and cold Parquet on one table — install, manage, flush, merge scan, and changes_since.
• TypeScript SDK: build browser apps, services, workers, and agents with the TypeScript packages.
• Rust SDK: native async client for services and workers — install kalam-client from crates.io.
• Dart / Flutter SDK: kalam init --languages dart then kalam_sync. Use kalam_link when you only need live SQL.
• Use Cases: runnable TypeScript example apps from the examples/ folder.

Start Here

1. Run KalamDB locally in minutes or kalam init + kalam dev
2. Create tables and query data with SQL
3. Connect a TypeScript app or service
4. Install the Rust SDK from crates.io and try the Quickstart example
5. Use pg_kalam for PostgreSQL-facing workflows
6. Try pg Koldstore for tiered hot/cold tables
7. Connect a Flutter app with kalam_sync
8. Review production security settings