https://github.com/cometbft/cometbft-db
Database wrapper for CometBFT
https://github.com/cometbft/cometbft-db
Last synced: about 1 year ago
JSON representation
Database wrapper for CometBFT
- Host: GitHub
- URL: https://github.com/cometbft/cometbft-db
- Owner: cometbft
- License: apache-2.0
- Created: 2022-12-22T23:08:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-13T19:24:52.000Z (about 1 year ago)
- Last Synced: 2025-05-13T20:45:22.559Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 850 KB
- Stars: 31
- Watchers: 6
- Forks: 68
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# CometBFT DB
[](https://github.com/cometbft/cometbft-db/releases/latest)
[](https://github.com/cometbft/cometbft-db/blob/main/LICENSE)
[](https://pkg.go.dev/github.com/cometbft/cometbft-db)
[](https://codecov.io/gh/cometbft/cometbft-db)
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.23+
## Supported Database Backends
- **[GoLevelDB](https://github.com/syndtr/goleveldb) [stable]**: A pure Go
implementation of [LevelDB](https://github.com/google/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](https://github.com/google/btree). 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](https://github.com/tendermint/iavl) working
sets when the pruning strategy allows it.
- **[LevelDB](https://github.com/google/leveldb) [DEPRECATED]:** A [Go
wrapper](https://github.com/jmhodges/levigo) around
[LevelDB](https://github.com/google/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](https://github.com/etcd-io/bbolt) [DEPRECATED]:** A
[fork](https://github.com/etcd-io/bbolt) of
[BoltDB](https://github.com/boltdb/bolt). Uses B+trees for on-disk storage,
which have good performance for read-heavy workloads and range scans. Supports
serializable ACID transactions.
- **[RocksDB](https://github.com/linxGnu/grocksdb) [experimental]:** A [Go
wrapper](https://github.com/linxGnu/grocksdb) around
[RocksDB](https://rocksdb.org). 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](https://github.com/dgraph-io/badger) [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.
- **[PebbleDB](https://github.com/cockroachdb/pebble) [experimental]:** Pebble
is a LevelDB/RocksDB inspired key-value store focused on performance and
internal usage by CockroachDB. Pebble inherits the RocksDB file formats and a
few extensions such as range deletion tombstones, table-level bloom filters,
and updates to the MANIFEST format.
CAVEAT: there are reports of broken upgrade process when using [Cosmos
SDK](https://github.com/cosmos/cosmos-sdk).
## 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.
## 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:
```bash
make docker-test-image
make docker-test
```
[tm-db]: https://github.com/tendermint/tm-db
[CometBFT]: https://github.com/cometbft/cometbft-db
[Cosmos SDK]: https://github.com/cosmos/cosmos-sdk
[cometbft/cometbft\#48]: https://github.com/cometbft/cometbft/issues/48