Skip to main content

KWDB Quick Start Guide

KWDB is an open source distributed multi-model database product incubated by OpenAtom Foundation. The best KWDB starting path depends on your goal: run a local instance, test time-series and relational fusion queries, explore sample data, or let an Agent help generate SQL and inspection steps.

1. Run KWDB Locally

If you want the shortest local path, start with the 5-minute quick start. It covers Docker startup, SQL Shell access, creating time-series and relational databases, inserting data, and running cross-model queries.

This path matches searches such as:

  • KWDB quick start
  • KWDB Docker deployment
  • KWDB tutorial

2. Try Queries Without Local Setup

If you do not want to install a local environment yet, use KWDB Playground. Playground is better for demos, training, and course-style exploration.

You can run example SQL first, then reproduce the same model locally.

3. Learn From Realistic Sample Data

If you care about smart meters, window functions, aggregate functions, and cross-model queries, start with KWDB SampleDB. It is closer to realistic business data than an empty-table tutorial.

4. Use Agent-Assisted Workflows

If you use a local agent environment, install KWDB Agent Skills. They cover Text2SQL, installation and deployment, inspection, performance review, and troubleshooting workflows.

  1. Read What Is KWDB.
  2. Run the 5-minute quick start.
  3. Validate cross-model queries with SampleDB.
  4. Install Agent Skills for day-to-day development and operations.