badger

Documentation

Overview

Package badger providers a Badger-backed implementation of kv.Txn.

Index

• func DefaultOptions(dir string) badger.Options
• type DB
  • func Open(opt badger.Options) (*DB, error)
  • func (db *DB) Close() error
  • func (db *DB) Dump(w io.Writer)
  • func (db *DB) NewTxn(update bool) kv.TxnCommitDiscarder

Functions

func DefaultOptions

func DefaultOptions(dir string) badger.Options

DefaultOptions returns a recommended default Options value for a database rooted at dir.

Types

type DB

type DB struct {
	*badger.DB
	// contains filtered or unexported fields
}

DB holds some kv-specific state in addition to mixing in a badger.DB.

func Open

func Open(opt badger.Options) (*DB, error)

Open creates a new DB with the given options.

func (*DB) Close

func (db *DB) Close() error

Close releases unallocated Entity values and closes the database.

func (*DB) Dump

func (db *DB) Dump(w io.Writer)

func (*DB) NewTxn

func (db *DB) NewTxn(update bool) kv.TxnCommitDiscarder

NewTxn creates a new kv.Txn.