btcd/database
Olaoluwa Osuntokun 4f114e519f treap: add benchmarks for batched Put, Delete, and mixed operations
In this commit, we add four benchmark functions to measure the
performance of the immutable treap's pool-based node recycling:

BenchmarkImmutablePutBatch exercises batched Put at batch sizes of 1,
10, 100, and 1000 keys using SHA-256 hashed keys to produce unordered
insertion patterns.

BenchmarkImmutableDeleteBatch measures batched Delete at the same
scales, first building a treap and then deleting all keys in one batch.

BenchmarkImmutablePutSequential simulates the IBD hot path by
performing 10 rounds of 100-key batch inserts into a growing treap,
exercising recycling across multiple Put calls.

BenchmarkImmutableMixedPutDelete mirrors the commitTx pattern in
dbcache.go by inserting 500 keys then deleting 250, measuring the
combined allocation overhead of interleaved batch operations.
2026-03-25 16:37:52 -07:00
..
cmd/dbtool dbtool: add TestNet4 config param 2025-03-18 11:18:38 -05:00
ffldb ffldb: batch Delete operations in commitTx for pool recycling 2026-03-25 16:37:34 -07:00
internal/treap treap: add benchmarks for batched Put, Delete, and mixed operations 2026-03-25 16:37:52 -07:00
testdata database: Replace with new version. 2016-04-12 14:55:15 -05:00
doc.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
driver.go multi: remove repetitive the 2023-06-26 15:40:51 +08:00
driver_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
error.go fix typos (#2100) 2024-03-25 09:44:25 -04:00
error_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
example_test.go multi: fix ioutil deprecated function 2024-03-08 17:41:41 -08:00
export_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
interface.go fix typos (#2100) 2024-03-25 09:44:25 -04:00
log.go all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
README.md docs: update shields 2021-03-05 07:45:19 -05:00

database

Build Status ISC License GoDoc

Package database provides a block and metadata storage database.

Please note that this package is intended to enable btcd to support different database backends and is not something that a client can directly access as only one entity can have the database open at a time (for most database backends), and that entity will be btcd.

When a client wants programmatic access to the data provided by btcd, they'll likely want to use the rpcclient package which makes use of the JSON-RPC API.

However, this package could be extremely useful for any applications requiring Bitcoin block storage capabilities.

The default backend, ffldb, has a strong focus on speed, efficiency, and robustness. It makes use of leveldb for the metadata, flat files for block storage, and strict checksums in key areas to ensure data integrity.

Feature Overview

  • Key/value metadata store
  • Bitcoin block storage
  • Efficient retrieval of block headers and regions (transactions, scripts, etc)
  • Read-only and read-write transactions with both manual and managed modes
  • Nested buckets
  • Iteration support including cursors with seek capability
  • Supports registration of backend databases
  • Comprehensive test coverage

Installation and Updating

$ go get -u github.com/btcsuite/btcd/database

Examples

  • Basic Usage Example
    Demonstrates creating a new database and using a managed read-write transaction to store and retrieve metadata.

  • Block Storage and Retrieval Example
    Demonstrates creating a new database, using a managed read-write transaction to store a block, and then using a managed read-only transaction to fetch the block.

License

Package database is licensed under the copyfree ISC License.