RocksDbSharp Namespace
The RocksDbSharp namespace contains the high-level, handle-managed C# types
for working with a RocksDB database. The pages below document the primary
public surface drawn from the guides and configuration sections. For the
conceptual background see Core Concepts, and for
task-oriented recipes see the Guides.
Classes
| Class | Description |
|---|---|
RocksDb |
The database handle. Open/close a database and run reads, writes, iterators, snapshots, and checkpoints. |
WriteBatch |
Groups multiple writes into a single atomic operation. |
Iterator |
Ordered cursor over a database or column family for range, prefix, and reverse scans. |
DbOptions |
Database-wide settings passed to every RocksDb.Open* overload. |
ReadOptions |
Per-call options for Get, MultiGet, and NewIterator. |
WriteOptions |
Per-call durability and WAL options for Put, Merge, Remove, and Write. |
Related types
These supporting types appear throughout the API surface and are documented in the guides and configuration sections rather than as standalone class pages:
| Type | Description |
|---|---|
Snapshot |
Point-in-time view created with RocksDb.CreateSnapshot. See Snapshots. |
Checkpoint |
On-disk consistent copy created with RocksDb.Checkpoint. See Checkpoints. |
ColumnFamilies / ColumnFamilyHandle |
Column-family descriptors and runtime handles. See Column families. |
ColumnFamilyOptions |
Per-column-family tuning. See ColumnFamilyOptions. |
WriteBatchWithIndex |
Indexed write batch you can read back before committing. See Write batches. |