mirror of
https://github.com/btcsuite/btcd.git
synced 2026-08-13 12:32:51 +02:00
ba5407615d
The doc formatting changes introduced in the recent go version is increasing the diff for all of the new commits. Formatting it all in this commit will help the readability of future PRs by reducing the diff. |
||
|---|---|---|
| .. | ||
| bench_test.go | ||
| blockio.go | ||
| db.go | ||
| dbcache.go | ||
| doc.go | ||
| driver.go | ||
| driver_test.go | ||
| export_test.go | ||
| interface_test.go | ||
| ldbtreapiter.go | ||
| mockfile_test.go | ||
| README.md | ||
| reconcile.go | ||
| whitebox_test.go | ||
ffldb
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.