dcrd/database2/ffldb
Dave Collins 2030b4d057 multi: Fix several misspellings in the comments.
Contains the following upstream commits:
- ef9c50be57
- eb882f39f8

In addition to merging the fixes in the commits, this also fixes a few
more misspellings that were introduced in the new Decred code.
2016-05-30 12:24:21 -05:00
..
bench_test.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
blockio.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
db.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
dbcache.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
doc.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
driver_test.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
driver.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
export_test.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
interface_test.go multi: Fix several misspellings in the comments. 2016-05-30 12:24:21 -05:00
ldbtreapiter.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
mockfile_test.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
README.md database: Update for Decred. 2016-05-25 23:09:31 -05:00
reconcile.go database: Update for Decred. 2016-05-25 23:09:31 -05:00
whitebox_test.go database: Update for Decred. 2016-05-25 23:09:31 -05:00

ffldb

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

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 dcrd. 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
}

Documentation

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

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/ffldb

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/ffldb

License

Package ffldb is licensed under the copyfree ISC License.