Liking cljdoc? Tell your friends :D

RocksDB

RocksDB is often used as Crux’s primary kv-store.

In order to use RocksDB within Crux, you must first add RocksDB as a project dependency:

Project Dependency

example$deps.edn

Starting a node using RocksDB

link:example$src/docs/examples.clj[role=include]

Please note that when configuring a standalone node with persisted indexes (via :crux.kv/db-dir), you should always have the tx-log and document-store persisted as well (via :crux.standalone/event-log-dir). Crux does not currently enforce this constraint or disallow otherwise invalid topology combinations.

You can create a node with custom RocksDB options by passing extra keywords in the topology. These are:

  • :crux.kv.rocksdb/disable-wal?, which takes a boolean (if true, disables the write ahead log)

  • :crux.kv.rocksdb/db-options, which takes a RocksDB 'Options' object (see more here, from the RocksDB javadocs)

To include RocksDB metrics in monitoring crux.kv.rocksdb/kv-store-with-metrics should be included in the topology map instead of the above.

❮QueriesSQL❯

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcutsReport a problemcljdoc on GitHub
× close