database

Documentation

Index

• type BadgerDB
  • func Open(path string) (*BadgerDB, error)
  • func OpenTruncate(path string) (*BadgerDB, error)
  • func (b *BadgerDB) Close() error

Types

type BadgerDB

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

BadgerDB is a wrapper around the standard badger.DB that provides a background compaction routine.

func Open

func Open(path string) (*BadgerDB, error)

Open opens (initializing if necessary) a Badger database at the specified path. Users must close the DB with Close().

func OpenTruncate

func OpenTruncate(path string) (*BadgerDB, error)

OpenTruncate opens (initializing and/or truncating if necessary) a Badger database at the specified path. Users must close the DB with Close().

Prefer Open in the general case, but after a bad shutdown it may be necessary to call OpenTruncate. This may cause data loss. Detect this situation by looking for badger.ErrTruncateNeeded.

func (*BadgerDB) Close

func (b *BadgerDB) Close() error

Close closes the database connection and releases the associated resources.