dcrd/database
Dave Collins 05e66dcaca
database: Use TempDir to create temp test dirs.
This modifies several of the tests to use t.TempDir.  The directory it
creates is automatically removed when the test and all its subtests
complete.

It also changes out some of the cleanup logic for closing the database
to use t.Cleanup instead of defer to ensure the close happens during
test cleanup after the directories created by t.TempDir have been
removed.
2023-06-15 15:05:45 -05:00
..
cmd/dbtool multi: Introduce database/v3 module. 2021-08-02 08:29:46 -05:00
ffldb database: Use TempDir to create temp test dirs. 2023-06-15 15:05:45 -05:00
internal/treap multi: Go 1.19 doc comment formatting. 2022-07-30 04:08:58 -05:00
testdata multi: Only use module-scoped data in tests. 2018-08-16 15:08:07 -05:00
doc.go multi: Go 1.19 doc comment formatting. 2022-07-30 04:08:58 -05:00
driver_test.go database: Mark test helpers. 2023-06-15 15:05:45 -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 database: Prepare v3.0.1. 2023-06-08 13:33:13 -05:00
go.sum database: Prepare v3.0.1. 2023-06-08 13:33:13 -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

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.