mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 09:50:08 +01:00
Code Issues Projects Releases Wiki Activity
9918e2a561
btcd/database
History
Dave Collins 9918e2a561
multi: Update markdown files for GFM changes. 
The github markdown interpreter has been changed such that it no longer
allows spaces in between the brackets and parenthesis of links and now
requires a newline in between anchors and other formatting.  This
updates all of the markdown files accordingly.

While here, it also corrects a couple of inconsistencies in some of the
README.md files.
2017-05-25 12:06:16 -05:00
..
cmd/dbtool Drop btcsuite/go-flags in favor of upstream 2017-01-09 14:10:18 -06:00
ffldb multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05:00
internal/treap multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05:00
testdata database: Replace with new version. 2016-04-12 14:55:15 -05:00
doc.go database: Update overview documentation in doc.go. 2017-05-21 18:22:33 -05:00
driver_test.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
error_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
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_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
log.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
README.md multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05: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 btcrpcclient 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.