decred.org/dcrwallet/v3@v3.1.0/wallet/internal/bdb/doc.go (about)

     1  // Copyright (c) 2014 The btcsuite developers
     2  // Copyright (c) 2015 The Decred developers
     3  // Use of this source code is governed by an ISC
     4  // license that can be found in the LICENSE file.
     5  
     6  /*
     7  Package bdb implements an instance of walletdb that uses boltdb for the backing
     8  datastore.
     9  
    10  # Usage
    11  
    12  This package is only a driver to the walletdb package and provides the database
    13  type of "bdb".  The only parameter the Open and Create functions take is the
    14  database path as a string:
    15  
    16  	db, err := walletdb.Open("bdb", "path/to/database.db")
    17  	if err != nil {
    18  		// Handle error
    19  	}
    20  
    21  	db, err := walletdb.Create("bdb", "path/to/database.db")
    22  	if err != nil {
    23  		// Handle error
    24  	}
    25  */
    26  package bdb