zecfoundation
/
btcd
mirror of https://github.com/ZcashFoundation/btcd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
btcd/database
History
Jake Sylvestre d08785547a docs: update shields 2021-03-05 07:45:19 -05:00
..
cmd/dbtool removed unnecessary GOMAXPROCS function calls 2020-09-14 09:57:30 -04:00
ffldb docs: update shields 2021-03-05 07:45:19 -05:00
internal/treap docs: update shields 2021-03-05 07:45:19 -05:00
testdata database: Replace with new version. 2016-04-12 14:55:15 -05:00
README.md docs: update shields 2021-03-05 07:45:19 -05:00
doc.go database: Update overview documentation in doc.go. 2017-05-21 18:22:33 -05:00
driver.go Fix a ton of typos accumulated over time 2017-05-30 16:59:51 +02: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 all: Remove seelog logger. 2017-06-19 16:46:50 -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 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 rpcclient package which makes use of the JSON-RPC API.

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

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