b688a6d891
Recently the Bucket and Tx interfaces were split into Read and ReadWrite versions. This commit updates the godoc for the bdb interface implementation to be consistent with this change. |
||
|---|---|---|
| .. | ||
| db.go | ||
| doc.go | ||
| driver.go | ||
| driver_test.go | ||
| interface_test.go | ||
| README.md | ||
bdb
[
]
(https://travis-ci.org/btcsuite/btcwallet)
Package bdb implements an driver for walletdb that uses boltdb for the backing datastore. Package bdb is licensed under the copyfree ISC license.
Usage
This package is only a driver to the walletdb package and provides the database type of "bdb". The only parameter the Open and Create functions take is the database path as a string:
db, err := walletdb.Open("bdb", "path/to/database.db")
if err != nil {
// Handle error
}
db, err := walletdb.Create("bdb", "path/to/database.db")
if err != nil {
// Handle error
}
Documentation
[
]
(http://godoc.org/github.com/btcsuite/btcwallet/walletdb/bdb)
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/btcwallet/walletdb/bdb
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/btcwallet/walletdb/bdb
License
Package bdb is licensed under the copyfree ISC License.