types

Documentation

Index

• type Engine
• type Operations
• type Tx
• type TxCommitDiscarder
• type TxRenewer

Types

type Engine

type Engine interface {
	Operations

	// Close closes the database engine and frees resources
	Close() error
}

Engine provides an interface that describes a storage engine

type Operations

type Operations interface {

	// Put adds a record to the database.
	// It will discard the transaction if an error occurred.
	Put(record *common.Record) error

	// Get a record by key
	Get(key []byte) (*common.Record, error)

	// Del deletes a record by key
	Del(key []byte) error

	// Iterate finds a set of records by prefix and passes them to iterFunc
	// for further processing.
	//
	// If iterFunc returns true, the iteration is stopped and immediately released.
	//
	// If first is set to true, it begins from the first record, otherwise
	// it will begin from the last record
	Iterate(prefix []byte, first bool, iterFunc func(rec *common.Record) bool)

	// RawIterator returns badger's Iterator
	RawIterator(opts interface{}) interface{}

	// NewBatch returns a batch writer
	NewBatch() interface{}

	// NewTx creates a new transaction.
	//
	// autoFinish: ensure that the underlying transaction is committed after
	// each successful operation.
	//
	// renew: re-initializes the transaction after each operation. Requires
	// autoFinish to be enabled.
	NewTx(autoFinish, renew bool) Tx
}

Operations describe the operations of Functions

type Tx

type Tx interface {
	TxCommitDiscarder
	Operations
	TxRenewer
}

Tx describes a transaction

type TxCommitDiscarder

type TxCommitDiscarder interface {
	CanFinish() bool
	Commit() error
	Discard()
}

TxCommitDiscarder represents an interface for committing and discarding a transaction

type TxRenewer

type TxRenewer interface {
	RenewTx()
}

TxRenewer represents an interface for renewing transaction