ZoneTree/docs/README.md

ZoneTree Docs

ZoneTree is a high-performance LSM-tree storage engine for .NET. It provides ordered, persistent key-value storage that can be used directly or as the foundation for databases, indexes, queues, search systems, event stores, and custom data platforms.

These docs explain the mental model behind ZoneTree, the main APIs, and the operational choices that matter in production.

Start here

• Getting started
• Storage engine model
• Reads and writes
• Value mutability
• Iteration and range scans
• Maintenance

Concepts

• LSM-tree model
• Key ordering
• Deletion markers and TTL
• Operation indexes
• Value mutability

Usage

• Opening a tree
• Reads and writes
• Iteration and range scans
• Atomic operations
• Transactions
• Maintenance

Durability

• WAL modes
• Recovery
• Backups

Storage

• Memory usage
• Disk segments
• Read-path caching
• Compression
• Serializers and comparers

Tuning

• Write-heavy workloads
• Read-heavy workloads
• Disk segment tuning
• Large values
• Billion-record datasets

Build On ZoneTree

• Indexes
• Queues
• Event stores
• Time-series storage
• Partitioning and replication

Operations

• Production checklist
• Troubleshooting
• Diagnostics

Reference

• Configuration
• API overview