Quick Start
Get KalamDB up and running in minutes. Choose between building from source or using Docker.
Prerequisites
- Rust 1.92+ (for building from source)
- Docker (for containerized deployment)
- Git
Option 1: Build from Source
# Clone the repository
git clone https://github.com/jamals86/KalamDB.git
cd KalamDB/backend
# Run the server (uses config.toml or defaults)
cargo run --release --bin kalamdb-serverThe server starts on http://localhost:8080 by default.
Option 2: Docker (Recommended)
See the Docker Deployment page for single-node and cluster setups.
Your First Commands
Once the server is running, install and start the CLI:
# Start the interactive CLI (connects as root on localhost by default)
kalamInside the kalam> prompt, create your first namespace and table:
-- Create a namespace
CREATE NAMESPACE IF NOT EXISTS myapp;
-- Create a user table
CREATE TABLE myapp.messages (
id BIGINT PRIMARY KEY DEFAULT SNOWFLAKE_ID(),
sender TEXT NOT NULL,
content TEXT NOT NULL,
created_at TIMESTAMP DEFAULT NOW()
) WITH (TYPE = 'USER');
-- Insert data
INSERT INTO myapp.messages (sender, content)
VALUES ('alice', 'Hello, KalamDB!');
-- Query it back
SELECT * FROM myapp.messages;Next Steps
- Admin UI Guide — Operate KalamDB from the web UI
- Docker Deployment — Run single-node or 3-node clusters
- CLI Guide — Install, authenticate, run queries, and use live subscriptions
- SQL Reference — Full SQL syntax documentation
Last updated on