badger

Documentation

Index

• Constants
• func NewDriver() driver.NamedDriver
• func NewFileDriver() driver.NamedDriver
• func NewUnversionedPersistence(dataSourceName string, config driver.Config) (driver.UnversionedPersistence, error)
• func NewUnversionedPersistenceNotifier(dataSourceName string, config driver.Config) (driver.UnversionedNotifier, error)
• func NewVersionedPersistence(dataSourceName string, config driver.Config) (driver.VersionedPersistence, error)
• func NewVersionedPersistenceNotifier(dataSourceName string, config driver.Config) (driver.VersionedNotifier, error)
• type DB
  • func OpenDB(opts Opts, config driver.Config) (*DB, error)
  • func (db *DB) Close() error
  • func (db *DB) DeleteState(namespace driver2.Namespace, key driver2.PKey) error
  • func (db *DB) DeleteStates(namespace driver2.Namespace, keys ...driver2.PKey) map[driver2.PKey]error
  • func (db *DB) GetState(namespace driver2.Namespace, key driver2.PKey) (driver.VersionedValue, error)
  • func (db *DB) GetStateMetadata(namespace driver2.Namespace, key driver2.PKey) (driver2.Metadata, driver2.RawVersion, error)
  • func (db *DB) GetStateRangeScanIterator(namespace string, startKey string, endKey string) (driver.VersionedResultsIterator, error)
  • func (db *DB) GetStateSetIterator(ns driver2.Namespace, keys ...driver2.PKey) (driver.VersionedResultsIterator, error)
  • func (db *DB) NewWriteTransaction() (driver.WriteTransaction, error)
  • func (db *DB) SetState(namespace driver2.Namespace, key string, value driver.VersionedValue) error
  • func (db *DB) SetStateMetadata(namespace driver2.Namespace, key driver2.PKey, metadata driver2.Metadata, ...) error
  • func (db *DB) SetStateMetadatas(ns driver2.Namespace, kvs map[driver2.PKey]driver.VersionedMetadataValue) map[driver2.PKey]error
  • func (db *DB) SetStates(namespace driver2.Namespace, kvs map[driver2.PKey]driver.VersionedValue) map[driver2.PKey]error
  • func (db *DB) Stats() any
• type Driver
  • func (d *Driver) NewTransactionalUnversioned(dataSourceName string, config driver.Config) (driver.TransactionalUnversionedPersistence, error)
  • func (d *Driver) NewTransactionalVersioned(dataSourceName string, config driver.Config) (driver.TransactionalVersionedPersistence, error)
  • func (d *Driver) NewUnversioned(dataSourceName string, config driver.Config) (driver.UnversionedPersistence, error)
  • func (d *Driver) NewVersioned(dataSourceName string, config driver.Config) (driver.VersionedPersistence, error)
• type Opts
• type Txn
  • func (t *Txn) Rollback() error
• type WriteTransaction
  • func (w *WriteTransaction) Commit() error
  • func (w *WriteTransaction) DeleteState(namespace driver2.Namespace, key driver2.PKey) error
  • func (w *WriteTransaction) Discard() error
  • func (w *WriteTransaction) SetState(namespace driver2.Namespace, key driver2.PKey, value driver.VersionedValue) error

Constants

const (
	BadgerPersistence driver2.PersistenceType = "badger"
	FilePersistence   driver2.PersistenceType = "file"
)

Functions

func NewDriver

func NewDriver() driver.NamedDriver

func NewFileDriver

func NewFileDriver() driver.NamedDriver

func NewUnversionedPersistence

func NewUnversionedPersistence(dataSourceName string, config driver.Config) (driver.UnversionedPersistence, error)

func NewUnversionedPersistenceNotifier

func NewUnversionedPersistenceNotifier(dataSourceName string, config driver.Config) (driver.UnversionedNotifier, error)

func NewVersionedPersistence

func NewVersionedPersistence(dataSourceName string, config driver.Config) (driver.VersionedPersistence, error)

func NewVersionedPersistenceNotifier

func NewVersionedPersistenceNotifier(dataSourceName string, config driver.Config) (driver.VersionedNotifier, error)

Types

type DB

type DB struct {
	*common.BaseDB[*Txn]
	// contains filtered or unexported fields
}

func OpenDB

func OpenDB(opts Opts, config driver.Config) (*DB, error)

func (*DB) Close

func (db *DB) Close() error

func (*DB) DeleteState

func (db *DB) DeleteState(namespace driver2.Namespace, key driver2.PKey) error

func (*DB) DeleteStates

func (db *DB) DeleteStates(namespace driver2.Namespace, keys ...driver2.PKey) map[driver2.PKey]error

func (*DB) GetState

func (db *DB) GetState(namespace driver2.Namespace, key driver2.PKey) (driver.VersionedValue, error)

func (*DB) GetStateMetadata

func (db *DB) GetStateMetadata(namespace driver2.Namespace, key driver2.PKey) (driver2.Metadata, driver2.RawVersion, error)

func (*DB) GetStateRangeScanIterator

func (db *DB) GetStateRangeScanIterator(namespace string, startKey string, endKey string) (driver.VersionedResultsIterator, error)

func (*DB) GetStateSetIterator

func (db *DB) GetStateSetIterator(ns driver2.Namespace, keys ...driver2.PKey) (driver.VersionedResultsIterator, error)

func (*DB) NewWriteTransaction

func (db *DB) NewWriteTransaction() (driver.WriteTransaction, error)

func (*DB) SetState

func (db *DB) SetState(namespace driver2.Namespace, key string, value driver.VersionedValue) error

func (*DB) SetStateMetadata

func (db *DB) SetStateMetadata(namespace driver2.Namespace, key driver2.PKey, metadata driver2.Metadata, version driver2.RawVersion) error

func (*DB) SetStateMetadatas

func (db *DB) SetStateMetadatas(ns driver2.Namespace, kvs map[driver2.PKey]driver.VersionedMetadataValue) map[driver2.PKey]error

func (*DB) SetStates

func (db *DB) SetStates(namespace driver2.Namespace, kvs map[driver2.PKey]driver.VersionedValue) map[driver2.PKey]error

func (*DB) Stats

func (db *DB) Stats() any

type Driver

type Driver struct{}

func (*Driver) NewTransactionalUnversioned

func (d *Driver) NewTransactionalUnversioned(dataSourceName string, config driver.Config) (driver.TransactionalUnversionedPersistence, error)

func (*Driver) NewTransactionalVersioned

func (d *Driver) NewTransactionalVersioned(dataSourceName string, config driver.Config) (driver.TransactionalVersionedPersistence, error)

NewTransactionalVersioned returns a new TransactionalVersionedPersistence for the passed data source and config

func (*Driver) NewUnversioned

func (d *Driver) NewUnversioned(dataSourceName string, config driver.Config) (driver.UnversionedPersistence, error)

func (*Driver) NewVersioned

func (d *Driver) NewVersioned(dataSourceName string, config driver.Config) (driver.VersionedPersistence, error)

type Opts

type Opts struct {
	badger.Options
	Path string
}

type Txn

type Txn struct {
	*badger.Txn
}

func (*Txn) Rollback

func (t *Txn) Rollback() error

type WriteTransaction

type WriteTransaction struct {
	// contains filtered or unexported fields
}

func (*WriteTransaction) Commit

func (w *WriteTransaction) Commit() error

func (*WriteTransaction) DeleteState

func (w *WriteTransaction) DeleteState(namespace driver2.Namespace, key driver2.PKey) error

func (*WriteTransaction) Discard

func (w *WriteTransaction) Discard() error

func (*WriteTransaction) SetState

func (w *WriteTransaction) SetState(namespace driver2.Namespace, key driver2.PKey, value driver.VersionedValue) error