Skip to content

RocksDB

RocksDB is an embeddable, high-performance, persistent key-value store originally developed at Facebook. It is well suited to fast storage devices such as SSDs, and its efficient use of CPU and memory makes it a popular choice for embedded workloads. RocksDB is the recommended backend for single-node installations of Stalwart because of its speed and reliability.

Configuration

Section titled “Configuration”

The RocksDB backend is selected by choosing the RocksDb variant on the DataStore object (found in the WebUI under Settings › Storage › Data Store). The variant exposes the following fields:

  • path: filesystem path where the RocksDB data directory is stored (required).
  • blobSize: minimum size, in bytes, for an object to be stored in the blob store rather than inline in the metadata store. Default: 16834.
  • bufferSize: size of the in-memory write buffer, in bytes. A larger buffer improves write throughput at the cost of memory. Default: 134217728 (128 MB).
  • poolWorkers: number of worker threads dedicated to database operations. Defaults to the number of CPU cores available on the host.

RocksDB is also available as a backend for other stores (blob, search, in-memory) through the Default variant of the BlobStore, SearchStore, and InMemoryStore objects, in which case they reuse the configured data store.