dcrd/database
Dave Collins e052b9cbf2
multi: Remove non-root module replacements.
This modifies all of the modules, with the exception of the root module,
to remove all replacement directives from their go.mod files and update
the requirements and module sums accordingly.

While it is nice to be able to build and test directly from each module
directory and have it pull in the latest untagged changes when
developing, having all of the overrides in each module makes it
infeasible to use the module tools to help maintain the modules and thus
makes it quite difficult to ensure they are all independently accurate
for external consumers.

By maintaining all of the overrides in the root module and invoking all
builds and tests from it, the overrides will apply to ensure the latest
code is being built and tested.

This also modifies the tests script used with in CI to run all of the
tests from the root module accordingly.
2019-02-08 18:01:43 -06:00
..
cmd/dbtool multi: Reset testnet and bump to version 3. 2018-08-08 08:09:32 -05:00
ffldb multi: Remove unused code. 2018-10-31 21:50:09 -04: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: Remove non-root module replacements. 2019-02-08 18:01:43 -06:00
go.sum multi: Remove non-root module replacements. 2019-02-08 18:01:43 -06:00
interface.go Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
log.go multi: Replace btclog with slog. 2018-05-23 14:22:10 -05: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.