github.com/btcsuite/btcd@v0.24.0/database/ffldb/doc.go (about)

     1  // Copyright (c) 2015-2016 The btcsuite developers
     2  // Use of this source code is governed by an ISC
     3  // license that can be found in the LICENSE file.
     4  
     5  /*
     6  Package ffldb implements a driver for the database package that uses leveldb
     7  for the backing metadata and flat files for block storage.
     8  
     9  This driver is the recommended driver for use with btcd.  It makes use leveldb
    10  for the metadata, flat files for block storage, and checksums in key areas to
    11  ensure data integrity.
    12  
    13  # Usage
    14  
    15  This package is a driver to the database package and provides the database type
    16  of "ffldb".  The parameters the Open and Create functions take are the
    17  database path as a string and the block network:
    18  
    19  	db, err := database.Open("ffldb", "path/to/database", wire.MainNet)
    20  	if err != nil {
    21  		// Handle error
    22  	}
    23  
    24  	db, err := database.Create("ffldb", "path/to/database", wire.MainNet)
    25  	if err != nil {
    26  		// Handle error
    27  	}
    28  */
    29  package ffldb