53 lines
1.6 KiB
Markdown
53 lines
1.6 KiB
Markdown
|
ffldb
|
||
|
|
=====
|
||
|
|
|
||
|
|
[]
|
||
|
|
(https://travis-ci.org/btcsuite/btcd)
|
||
|
|
|
||
|
|
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
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
[]
|
||
|
|
(http://godoc.org/github.com/btcsuite/btcd/database/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/btcsuite/btcd/database/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/btcsuite/btcd/database/ffldb
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Package ffldb is licensed under the [copyfree](http://copyfree.org) ISC
|
||
|
|
License.
|