badger

Documentation

Index

• Variables
• func WithPlainKeys(o *opts) error
• type DB
  • func (d *DB[Db, Txn, Item, Wb]) Begin(prefix *record.Key, writable bool) keyvalue.ChangeSet
  • func (d *DB[Db, Txn, Item, Wb]) Close() error
• type Database
  • func New(filepath string, o ...Option) (*Database, error)
  • func OpenV1(filepath string, o ...Option) (*Database, error)
• type DatabaseV1
• type DatabaseV2
  • func OpenV2(filepath string, o ...Option) (*DatabaseV2, error)
• type DatabaseV3
  • func OpenV3(filepath string, o ...Option) (*DatabaseV3, error)
• type DatabaseV4
  • func OpenV4(filepath string, o ...Option) (*DatabaseV4, error)
• type Option

Variables

var TruncateBadger = false

TruncateBadger controls whether Badger is configured to truncate corrupted data. Especially on Windows, if the node is terminated abruptly, setting this may be necessary to recovering the state of the system.

However, Accumulate is not robust against this kind of interruption. If the node is terminated abruptly and restarted with this flag, some functions may break, such as synthetic transactions and anchoring.

Functions

func WithPlainKeys

func WithPlainKeys(o *opts) error

Types

type DB

type DB[Db dbImpl[Txn, Item, Wb], Txn txn[Item], Item item, Wb writeBatch] struct {
	// contains filtered or unexported fields
}

func (*DB[Db, Txn, Item, Wb]) Begin

func (d *DB[Db, Txn, Item, Wb]) Begin(prefix *record.Key, writable bool) keyvalue.ChangeSet

Begin begins a change set.

func (*DB[Db, Txn, Item, Wb]) Close

func (d *DB[Db, Txn, Item, Wb]) Close() error

Close Close the underlying database

type Database

type Database = DatabaseV1

func New

func New(filepath string, o ...Option) (*Database, error)

func OpenV1

func OpenV1(filepath string, o ...Option) (*Database, error)

type DatabaseV1

type DatabaseV1 = DB[*v1.DB, *v1.Txn, *v1.Item, *v1.WriteBatch]

type DatabaseV2

type DatabaseV2 = DB[*v2.DB, *v2.Txn, *v2.Item, *v2.WriteBatch]

func OpenV2

func OpenV2(filepath string, o ...Option) (*DatabaseV2, error)

type DatabaseV3

type DatabaseV3 = DB[*v3.DB, *v3.Txn, *v3.Item, *v3.WriteBatch]

func OpenV3

func OpenV3(filepath string, o ...Option) (*DatabaseV3, error)

type DatabaseV4

type DatabaseV4 = DB[*v4.DB, *v4.Txn, *v4.Item, *v4.WriteBatch]

func OpenV4

func OpenV4(filepath string, o ...Option) (*DatabaseV4, error)

type Option

type Option func(*opts) error