badger

Documentation

Index

• func NewBadger(name, location string) (storage.Interface, error)
• type Badger
  • func (b *Badger) Delete(key string) error
  • func (b *Badger) Get(key string) (record.Record, error)
  • func (b *Badger) GetMeta(key string) (*record.Meta, error)
  • func (b *Badger) Injected() bool
  • func (b *Badger) Maintain(_ context.Context) error
  • func (b *Badger) MaintainRecordStates(ctx context.Context, purgeDeletedBefore time.Time, shadowDelete bool) error
  • func (b *Badger) MaintainThorough(_ context.Context) (err error)
  • func (b *Badger) Put(r record.Record) (record.Record, error)
  • func (b *Badger) Query(q *query.Query, local, internal bool) (*iterator.Iterator, error)
  • func (b *Badger) ReadOnly() bool
  • func (b *Badger) Shutdown() error

Functions

func NewBadger

func NewBadger(name, location string) (storage.Interface, error)

NewBadger opens/creates a badger database.

Types

type Badger

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

Badger database made pluggable for portbase.

func (*Badger) Delete

func (b *Badger) Delete(key string) error

Delete deletes a record from the database.

func (*Badger) Get

func (b *Badger) Get(key string) (record.Record, error)

Get returns a database record.

func (*Badger) GetMeta

func (b *Badger) GetMeta(key string) (*record.Meta, error)

GetMeta returns the metadata of a database record.

func (*Badger) Injected

func (b *Badger) Injected() bool

Injected returns whether the database is injected.

func (*Badger) Maintain

func (b *Badger) Maintain(_ context.Context) error

Maintain runs a light maintenance operation on the database.

func (*Badger) MaintainRecordStates

func (b *Badger) MaintainRecordStates(ctx context.Context, purgeDeletedBefore time.Time, shadowDelete bool) error

MaintainRecordStates maintains records states in the database.

func (*Badger) MaintainThorough

func (b *Badger) MaintainThorough(_ context.Context) (err error)

MaintainThorough runs a thorough maintenance operation on the database.

func (*Badger) Put

func (b *Badger) Put(r record.Record) (record.Record, error)

Put stores a record in the database.

func (*Badger) Query

func (b *Badger) Query(q *query.Query, local, internal bool) (*iterator.Iterator, error)

Query returns a an iterator for the supplied query.

func (*Badger) ReadOnly

func (b *Badger) ReadOnly() bool

ReadOnly returns whether the database is read only.

func (*Badger) Shutdown

func (b *Badger) Shutdown() error

Shutdown shuts down the database.