Getting Started

This section guides you through setting up and using Cobble for different use cases — from a single-machine embedded store to a distributed cluster with snapshot-following reads and parallel scans.

Start with Quick Start for runnable examples, then use the focused guides for deeper explanations:

Guide When to use
Quick Start Runnable examples for the main Cobble usage patterns
Basic Concepts Core components — Db, Coordinator, Reader, Scanner, snapshots
Configuration Every deployment starts here — volumes, tuning, and storage layout
Single-Machine Embedded DB Simple embedded key-value store on a single machine
Distributed DB Multiple writer shards coordinated by a global snapshot system
Reader & Distributed Scan Serve snapshot-following reads or run parallel analytical scans across shards
Remote Compaction Offload background compaction to dedicated worker nodes
Structured DB Type-safe row-oriented wrappers for all of the above
Table Named schemas, typed rows, Catalog management, and distributed table reads/writes

Table of contents


Copyright © Cobble contributors. Distributed under the Apache-2.0 License.

This site uses Just the Docs, a documentation theme for Jekyll.