package
0.8.2
Repository: https://github.com/joegruffins/dcrd.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# README

database

[Build Status] (https://travis-ci.org/decred/dcrd)

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] (https://github.com/decred/dcrd/tree/master/docs/json_rpc_api.md).

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

Documentation

[GoDoc] (http://godoc.org/github.com/decred/dcrd/database2)

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here: http://godoc.org/github.com/decred/dcrd/database2

You can also view the documentation locally once the package is installed with the godoc tool by running godoc -http=":6060" and pointing your browser to http://localhost:6060/pkg/github.com/decred/dcrd/database2

Installation

$ go get github.com/decred/dcrd/database2

Examples

License

Package database is licensed under the copyfree ISC License.