Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 4.36 KB

README.md

File metadata and controls

89 lines (68 loc) · 4.36 KB
Raw

CometBFT DB

version license API Reference codecov Lint Test

A fork of tm-db.

Common database interface for various database backends. Primarily meant for applications built on CometBFT, such as the Cosmos SDK.

NB: As per cometbft/cometbft#48, the CometBFT team plans on eventually totally deprecating and removing this library from CometBFT. As such, we do not recommend depending on this library for new projects.

Minimum Go Version

Go 1.20+

Supported Database Backends

  • GoLevelDB [stable]: A pure Go implementation of LevelDB (see below). Currently the default on-disk database used in the Cosmos SDK.

  • MemDB [stable]: An in-memory database using Google's B-tree package. Has very high performance both for reads, writes, and range scans, but is not durable and will lose all data on process exit. Does not support transactions. Suitable for e.g. caches, working sets, and tests. Used for IAVL working sets when the pruning strategy allows it.

  • LevelDB [experimental]: A Go wrapper around LevelDB. Uses LSM-trees for on-disk storage, which have good performance for write-heavy workloads, particularly on spinning disks, but requires periodic compaction to maintain decent read performance and reclaim disk space. Does not support transactions.

  • BoltDB [experimental]: A fork of BoltDB. Uses B+trees for on-disk storage, which have good performance for read-heavy workloads and range scans. Supports serializable ACID transactions.

  • RocksDB [experimental]: A Go wrapper around RocksDB. Similarly to LevelDB (above) it uses LSM-trees for on-disk storage, but is optimized for fast storage media such as SSDs and memory. Supports atomic transactions, but not full ACID transactions.

  • BadgerDB [experimental]: A key-value database written as a pure-Go alternative to e.g. LevelDB and RocksDB, with LSM-tree storage. Makes use of multiple goroutines for performance, and includes advanced features such as serializable ACID transactions, write batches, compression, and more.

Meta-databases

  • PrefixDB [stable]: A database which wraps another database and uses a static prefix for all keys. This allows multiple logical databases to be stored in a common underlying databases by using different namespaces. Used by the Cosmos SDK to give different modules their own namespaced database in a single application database.

  • RemoteDB [experimental]: A database that connects to distributed CometBFT db instances via gRPC. This can help with detaching difficult deployments such as LevelDB, and can also ease dependency management for CometBFT developers.

Tests

To test common databases, run make test. If all databases are available on the local machine, use make test-all to test them all.

To test all databases within a Docker container, run:

make docker-test-image
make docker-test