Skip to content
WeftKitBeta

Quickstart

Quickstart

Pull a WeftKit database image and run your first query in under 5 minutes. WeftKit is distributed exclusively as Docker images — there is nothing to compile and nothing to install on the host beyond a Docker runtime.

Prerequisites

  • Docker 24+ or Podman 5+ (any OCI-compatible runtime)
  • About 500 MB of free disk space per engine for the image and data volume

Pull Your First Engine

Every engine ships as an independent image at weftkit/<engine>:0.1.0. Start with the relational engine:

bash
docker pull weftkit/relational:0.1.0

Run It

bash
docker run -d \
  --name weftkit-rel \
  -p 20000:20000 \
  -p 9100:9100 \
  -v weftkit-rel-data:/var/lib/weftkit/data \
  weftkit/relational:0.1.0

What the ports do:

  • 20000 — PostgreSQL-compatible wire protocol (connect with any psql client)
  • 9100 — WeftKit native protocol (used by the Gateway and Playground)

Connect and Query

Use any PostgreSQL-compatible client:

bash
psql -h localhost -p 20000 -U weftkit -d default
sql
CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT NOT NULL);
INSERT INTO users VALUES (1, 'Alice');
SELECT * FROM users;

What You Just Did

  1. Pulled a self-contained engine — the image carries its own storage engine, WAL, security layer, and wire-protocol listener. No external database process required.
  2. Mounted a persistent volume — weftkit-rel-data survives container restarts and image upgrades.
  3. Spoke a standard wire protocol — the relational engine answers PostgreSQL v3, so every existing driver and tool works unchanged.

Next Steps