lbcd/database
Dave Collins af524fb3e7
multi: Remove unnecessary convs found by unconvert.
This removes all unnecessary typecast conversions as found by the
unconvert linter.
2016-11-03 11:59:38 -05:00
..
cmd/dbtool chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
ffldb multi: Remove unnecessary convs found by unconvert. 2016-11-03 11:59:38 -05:00
internal/treap database: Replace with new version. 2016-04-12 14:55:15 -05:00
testdata database: Replace with new version. 2016-04-12 14:55:15 -05:00
doc.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
driver.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
driver_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
error.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
error_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
example_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
export_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
interface.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
log.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
log_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
README.md database: Replace with new version. 2016-04-12 14:55:15 -05:00

database

[Build Status] (https://travis-ci.org/btcsuite/btcd) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg) [GoDoc] (http://godoc.org/github.com/btcsuite/btcd/database)

Package database provides a block and metadata storage database.

Please note that this package is intended to enable btcd 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 btcd.

When a client wants programmatic access to the data provided by btcd, they'll likely want to use the btcrpcclient package which makes use of the [JSON-RPC API] (https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md).

However, this package could be extremely useful for any applications requiring Bitcoin 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
  • Bitcoin 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 and Updating

$ go get -u github.com/btcsuite/btcd/database

Examples

License

Package database is licensed under the copyfree ISC License.