Categorygithub.com/cometbft/cometbft-db
modulepackage
0.15.0
Repository: https://github.com/cometbft/cometbft-db.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
15
Dependents
1.1k
Files
1.3k SLOC

# README

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.23+

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 [DEPRECATED]: 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 [DEPRECATED]: 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.

  • PebbleDB [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.

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:

make docker-test-image
make docker-test

# Functions

No description provided by the author
See DB interface documentation for more information.
IteratePrefix is a convenience function for iterating over a key domain restricted by prefix.
NewDB creates a new database of type backend with the given name.
No description provided by the author
No description provided by the author
NewMemDB creates a new in-memory database.
NewPrefixDB lets you namespace multiple DBs within a single DB.

# Constants

BadgerDBBackend represents badger (uses github.com/dgraph-io/badger) - EXPERIMENTAL - use badgerdb build tag (go build -tags badgerdb).
BoltDBBackend represents bolt (uses etcd's fork of bolt - github.com/etcd-io/bbolt) - EXPERIMENTAL - may be faster is some use-cases (random reads - indexer) - use boltdb build tag (go build -tags boltdb).
CLevelDBBackend represents cleveldb (uses levigo wrapper) - fast - requires gcc - use cleveldb build tag (go build -tags cleveldb).
GoLevelDBBackend represents goleveldb (github.com/syndtr/goleveldb - most popular implementation) - pure go - stable - unmaintaned.
MemDBBackend represents in-memory key value store, which is mostly used for testing.
PebbleDBDBBackend represents pebble (uses github.com/cockroachdb/pebble) - EXPERIMENTAL - use pebbledb build tag (go build -tags pebbledb).
RocksDBBackend represents rocksdb (uses github.com/tecbot/gorocksdb) - EXPERIMENTAL - requires gcc - use rocksdb build tag (go build -tags rocksdb).

# Structs

No description provided by the author
MemDB is an in-memory database backend using a B-tree for storage.
PrefixDB wraps a namespace of another database as a logical database.

# Interfaces

Batch represents a group of writes.
DB is the main interface for all database backends.
Iterator represents an iterator over a domain of keys.

# Type aliases

No description provided by the author