dcrd/database
David Hill 6d39abb6be dcrutil: Start v3 module dev cycle.
Several upcoming changes constitute breaking the public API.
2019-10-24 19:13:26 -05:00
..
cmd/dbtool dcrutil: Start v3 module dev cycle. 2019-10-24 19:13:26 -05:00
ffldb dcrutil: Start v3 module dev cycle. 2019-10-24 19:13:26 -05:00
internal/treap build: Replace TravisCI with CI via Github actions. 2019-09-20 19:59:04 -05:00
testdata multi: Only use module-scoped data in tests. 2018-08-16 15:08:07 -05:00
doc.go database: Replace with new version. 2016-08-23 17:40:38 -04:00
driver_test.go multi: Correct typos. 2019-08-16 17:37:58 -05:00
driver.go multi: Correct typos. 2019-08-16 17:37:58 -05:00
error_test.go release: Introduce database v2 module. 2019-07-22 19:53:47 -05:00
error.go multi: Correct typos. 2019-08-16 17:37:58 -05:00
example_test.go dcrutil: Start v3 module dev cycle. 2019-10-24 19:13:26 -05:00
export_test.go multi: Correct typos. 2019-08-16 17:37:58 -05:00
go.mod dcrutil: Start v3 module dev cycle. 2019-10-24 19:13:26 -05:00
go.sum dcrutil: Start v3 module dev cycle. 2019-10-24 19:13:26 -05: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 build: Replace TravisCI with CI via Github actions. 2019-09-20 19:59:04 -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 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.