Getting Started
Tutorial: Building with CleaveDB
Bucket Configuration — Overview
In CleaveDB, a bucket is more than a simple document container. Each bucket possesses a dedicated storage policy, lifecycle rules, secondary indexes, write validation guards, and real-time event webhooks configured declaratively in CleaveQL.
Core bucket management commands
| Command | Primary role | Key capabilities |
|---|---|---|
| SHAPE | Bucket lifecycle & storage policy | AUDITED, VERSIONED, MAX DOCUMENTS, COMPRESSION, TTL |
| GUARD | Write-time schema validation | REQUIRED, type assertions, numeric bounds, enumeration sets (IN) |
| INDEX | B+Tree index acceleration | Single-field and composite multi-field indexes |
| DESCRIBE & SHOW | Metadata & resource inspection | Summarize document volumes, list buckets, bonds, indexes, stats, and webhooks |
| WEBHOOK | Change Data Capture (CDC) | HTTP event dispatch on POUR, CHANGE, and DRAIN actions |
Explore the Bucket Configuration topics
Step through each lesson to configure your storage buckets:
- SHAPE — configure buckets: audit logging, document versioning, capacity limits, and TTL retention.
- GUARD — validation rules: enforce field presence, types, numeric thresholds, and allowed values.
- INDEX — speed up lookups: create single-field and composite B+Tree indexes.
- DESCRIBE & SHOW: inspect bucket contents, cluster statistics, and active system resources.
- Webhooks: subscribe external services directly to mutation events without Kafka or Debezium.