ZoneTree Documentation

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.

Core Strengths

ZoneTree is strongest when it is treated as a storage-engine foundation: an ordered durable core for building higher-level data systems.

• Ordered keys make range scans, prefix layouts, secondary indexes, queues, and time-series layouts natural.
• The LSM-tree write path gives high-throughput persistent writes.
• Multipart disk segments reduce write amplification by keeping rewrite work local when ranges change.
• Operation indexes provide a producer write sequence for replay, audit, restore, and replication pipelines.
• Iterators, live backup, restore, transactions, and maintenance hooks make ZoneTree useful as a building block for larger data systems.

Start Here

1. Open a tree and run maintenance.
2. Learn the LSM-tree and segment model.
3. Choose the right read and write APIs.
4. Design keys for ordering and range scans.
5. Select a WAL durability mode.
6. Complete the production checklist.

Core Capabilities

• Ordered keys, forward and reverse iterators, seeks, and range scans
• Concurrent individual writes and atomic same-key read-modify-write operations
• Optimistic multi-key transactions
• Write-ahead logging, compressed disk segments, recovery, and live backup
• Custom serializers, comparers, key hashers, and storage providers
• Mutable-segment Bloom filtering and layered disk-read caching
• Multipart disk segments designed to limit persistent rewrite amplification

Use ZoneTree

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

Durability

• WAL modes
• Recovery
• Backups

Concepts And Storage

• Segments
• Bloom filters
• Key ordering
• Key components
• Deletion markers and TTL
• Operation indexes
• Value mutability
• Disk segments
• File stream providers
• Memory usage
• Compression

Operate And Tune

• Configuration reference
• Read-path caching
• Disk-segment tuning
• Write amplification
• Large values
• Diagnostics
• Troubleshooting
• Benchmark methodology
• API overview

Build On ZoneTree

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

ZoneTree exposes storage-engine building blocks rather than prescribing an application model. The engine owns ordered persistence and lifecycle safety; the application owns its key layout, indexes, transaction boundaries, durability requirements, and operational policy.