lbcd/database/ffldb
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
..
bench_test.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
blockio.go multi: Remove unnecessary convs found by unconvert. 2016-11-03 11:59:38 -05:00
db.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
dbcache.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -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
export_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
interface_test.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
ldbtreapiter.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
mockfile_test.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
reconcile.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
whitebox_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00

ffldb

Build Status ISC License GoDoc

Package ffldb implements a driver for the database package that uses leveldb for the backing metadata and flat files for block storage.

This driver is the recommended driver for use with btcd. It makes use leveldb for the metadata, flat files for block storage, and checksums in key areas to ensure data integrity.

Package ffldb is licensed under the copyfree ISC license.

Usage

This package is a driver to the database package and provides the database type of "ffldb". The parameters the Open and Create functions take are the database path as a string and the block network.

db, err := database.Open("ffldb", "path/to/database", wire.MainNet)
if err != nil {
	// Handle error
}
db, err := database.Create("ffldb", "path/to/database", wire.MainNet)
if err != nil {
	// Handle error
}

License

Package ffldb is licensed under the copyfree ISC License.