mirror of
https://github.com/btcsuite/btcd.git
synced 2025-02-24 06:47:59 +01:00
41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
ffldb
|
|
=====
|
|
|
|
[](https://github.com/btcsuite/btcd/actions)
|
|
[](http://copyfree.org)
|
|
[](https://pkg.go.dev/github.com/btcsuite/btcd/database/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.
|
|
|
|
```Go
|
|
db, err := database.Open("ffldb", "path/to/database", wire.MainNet)
|
|
if err != nil {
|
|
// Handle error
|
|
}
|
|
```
|
|
|
|
```Go
|
|
db, err := database.Create("ffldb", "path/to/database", wire.MainNet)
|
|
if err != nil {
|
|
// Handle error
|
|
}
|
|
```
|
|
|
|
## License
|
|
|
|
Package ffldb is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|