ffldb

README

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.

Documentation

Overview

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.

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
}

Index

• func TstRunWithMaxBlockFileSize(idb database.DB, size uint32, fn func())
• type TreapForEacher

Functions

func TstRunWithMaxBlockFileSize

func TstRunWithMaxBlockFileSize(idb database.DB, size uint32, fn func())

TstRunWithMaxBlockFileSize runs the passed function with the maximum allowed file size for the database set to the provided value. The value will be set back to the original value upon completion.

Callers should only use this for testing.

Types

type TreapForEacher

type TreapForEacher interface {
	ForEach(func(k, v []byte) bool)
}

TreapForEacher is an interface which allows iteration of a treap in ascending order using a user-supplied callback for each key/value pair. It mainly exists so both mutable and immutable treaps can be atomically committed to the database with the same function.