dcrd/database
Dave Collins c33be8c68c
multi: Update all modules for chaincfg v1.5.1.
This updates all of the modules that still rely on v1 of the chaincfg
module to use v1.5.1 which builds correctly with the major API bump
introduced in the edwards v1.0.0 module.

While here, it also updates all references to the v0 edwards and dcrec
modules to their tagged v1 counterparts, tidies all of the modules via
go mod tidy, and removes all unnecessary indirect entries from the mod
files to keep the modules using the versions the dependencies are tested
with.

The primary motivation for this change is that the chaincfg/v2 module
requires edwards/v1 which is not API compatible with edwards/v0.
Consequently, in order for each module to be incrementally updated to
use chaincfg/v2, all of its dependencies must also be able to build with
edwards/v1 which is the case as of chaincfg v1.5.1.
2019-06-17 15:54:31 -05:00
..
cmd/dbtool multi: Reset testnet and bump to version 3. 2018-08-08 08:09:32 -05:00
ffldb multi: cleanup linter warnings 2019-02-13 08:38:25 -05:00
internal/treap multi: Remove unused code. 2018-10-31 21:50:09 -04: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 database: Replace with new version. 2016-08-23 17:40:38 -04:00
driver.go multi: Replace btclog with slog. 2018-05-23 14:22:10 -05:00
error_test.go database: Replace with new version. 2016-08-23 17:40:38 -04:00
error.go indexers: Provide interface for index removal. 2018-03-27 18:50:03 -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
go.mod multi: Update all modules for chaincfg v1.5.1. 2019-06-17 15:54:31 -05:00
go.sum multi: Update all modules for chaincfg v1.5.1. 2019-06-17 15:54:31 -05:00
interface.go Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
log.go multi: deprecate DisableLog 2019-03-18 11:16:35 -05:00
README.md docs: move json rpc docs to mediawiki. 2019-03-19 17:33:38 +00: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.