dcrd/database
Dave Collins 4ebd135a82
multi: Round 2 prerel module release ver updates.
This modifies some recently-updated modules to use a valid prerelease
version so they can be used in require statements in consumer code that
is also under development.

Several commits are needed since there is a dependency chain that
involves transitive deps.

The updated direct dependencies are as follows:

- github.com/decred/dcrd/blockchain/stake/v4@v4.0.0-20210129181600-6ae0142d3b28
- github.com/decred/dcrd/blockchain/v4@4.0.0-20210129181600-6ae0142d3b28
- github.com/decred/dcrd/dcrutil/v4@v4.0.0-20210129181600-6ae0142d3b28
- github.com/decred/dcrd/hdkeychain/v3@v3.0.0-20210129181600-6ae0142d3b28
- github.com/decred/dcrd/txscript/v4@v4.0.0-20210129181600-6ae0142d3b28
2021-01-29 13:01:27 -06:00
..
cmd/dbtool multi: update database error types. 2020-12-18 13:40:32 -06:00
ffldb multi: update database error types. 2020-12-18 13:40:32 -06:00
internal/treap multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00
testdata multi: Only use module-scoped data in tests. 2018-08-16 15:08:07 -05:00
doc.go multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00
driver_test.go multi: update database error types. 2020-12-18 13:40:32 -06:00
driver.go multi: update database error types. 2020-12-18 13:40:32 -06:00
error_test.go multi: update database error types. 2020-12-18 13:40:32 -06:00
error.go multi: update database error types. 2020-12-18 13:40:32 -06:00
example_test.go multi: Start dcrutil v4 module dev cycle. 2020-12-16 16:30:24 -06:00
go.mod multi: Round 2 prerel module release ver updates. 2021-01-29 13:01:27 -06:00
go.sum multi: Round 2 prerel module release ver updates. 2021-01-29 13:01:27 -06:00
interface.go multi: Correct typos. 2019-08-16 17:37:58 -05:00
log.go multi: deprecate DisableLog 2019-03-18 11:16:35 -05:00
README.md multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00

database

Build Status ISC License Doc

Package database provides a block and metadata storage database.

Please note that this package is intended to enable dcrd 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 dcrd.

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

However, this package could be extremely useful for any applications requiring Decred 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
  • Decred 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

$ go get github.com/decred/dcrd/database2

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.