dcrd/database
Josh Rickmar 6842aa006d Merge remaining dcrutil code into a dcrd package.
This merge commit adds the following code from the
github.com/decred/dcrutil package into a new
github.com/decred/dcrd/dcrutil package:

* Address handling
* Amount type
* AppDataDir func
* bitflags functions
* Block wrapper type
* Hash160 func
* Tx wrapper type
* WIF type

as well as all tests for this code.

The old github.com/decred/dcrutil/hdkeychain package has also been
merged and moved to github.com/decred/dcrd/dcrutil/hdkeychain.

dcrd packages have been updated to use the new packages and the dep
files have been updated for this change.
2017-10-11 22:06:36 -04:00
..
cmd/dbtool Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
ffldb Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
internal/treap multi: Update markdown in README files to match change in github parser. 2017-05-26 12:06:19 -04:00
doc.go database: Replace with new version. 2016-08-23 17:40:38 -04:00
driver_test.go database: Replace with new version. 2016-08-23 17:40:38 -04:00
driver.go database: Replace with new version. 2016-08-23 17:40:38 -04:00
error_test.go database: Replace with new version. 2016-08-23 17:40:38 -04:00
error.go database: Replace with new version. 2016-08-23 17:40:38 -04:00
example_test.go Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
export_test.go database: Replace with new version. 2016-08-23 17:40:38 -04:00
interface.go Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
log.go all: Remove seelog logger. 2017-06-20 10:58:10 -04:00
README.md multi: Update markdown in README files to match change in github parser. 2017-05-26 12:06:19 -04: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.