flip/dcrd
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/dcrd.git synced 2026-02-06 10:56:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
90d73a17d3
dcrd/database
History
Dave Collins 90d73a17d3
multi: Only use module-scoped data in tests. 
This updates the tests in database/ffldb and blockchain/stake to
reference the block tests within the same module as opposed to escaping
the module to find it in the blockchain module.

This is necessary for the new test all functionality of the upcoming
go1.11 release since it individually tests each module in a separate
path and therefore it prevent the ability to use relative paths that
escape the module.

Unfortunately, this means the data had to be copied, but, but it's not a
huge amount of data, and it seems that git mostly deduplicates the data
internally.
2018-08-16 15:08:07 -05:00
..
cmd/dbtool multi: Reset testnet and bump to version 3. 2018-08-08 08:09:32 -05:00
ffldb multi: Only use module-scoped data in tests. 2018-08-16 15:08:07 -05:00
internal/treap multi: remove unused funcs and vars 2017-12-07 21:46:25 -06: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 release: Bump module versions and deps. 2018-08-09 14:30:22 -05:00
go.sum release: Bump module versions and deps. 2018-08-09 14:30:22 -05: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

README.md

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.