seedhammer/dcrd
seedhammer/dcrd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
cdf881d9ce
dcrd/database
History
Donald Adu-Poku 0c11ab5bd9 multi: avoid using subscriber lifecycle in catchup. 
This updates the index subscriber catchup function to update
subscriptions directly with notification instead of going through the
Run lifecycle process which avoids a case of receiving out of sync
index notifications while catch up is in progress.

Multiple typos in error type tests and review issues have also been
fixed in this commit.
2021-10-12 18:52:50 -05:00
..
cmd/dbtool multi: Introduce database/v3 module. 2021-08-02 08:29:46 -05:00
ffldb multi: Introduce database/v3 module. 2021-08-02 08:29:46 -05:00
internal/treap multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00
testdata multi: Only use module-scoped data in tests. 2018-08-16 15:08:07 -05:00
doc.go multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00
driver_test.go multi: Introduce database/v3 module. 2021-08-02 08:29:46 -05:00
driver.go multi: update database error types. 2020-12-18 13:40:32 -06:00
error_test.go multi: avoid using subscriber lifecycle in catchup. 2021-10-12 18:52:50 -05:00
error.go multi: integrate index subscriber. 2021-10-12 18:52:50 -05:00
example_test.go multi: Introduce database/v3 module. 2021-08-02 08:29:46 -05:00
go.mod multi: Introduce database/v3 module. 2021-08-02 08:29:46 -05:00
go.sum dcrutil: Convert to use new stdaddr package. 2021-04-15 16:58:25 -05:00
interface.go database: Add Flush to DB interface. 2021-05-13 22:43:30 -05:00
log.go database: Remove deprecated DisableLog. 2021-09-10 07:54:27 -05:00
README.md database: Correct README rpcclient link. 2021-09-01 10:18:45 -05:00

README.md

database

Build Status ISC License Doc

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 rpcclient 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.