badger

Documentation

Index

• Variables
• func BadgerGC(ctx context.Context, extendedOptions *BadgerGCOptions, db *badger.DB)
• func DefaultOptions(ctx context.Context, filePath string) badger.Options
• func LowMemLowCPUBadgerOptions(ctx context.Context, filePath string) badger.Options
• func LowMemOptions(ctx context.Context, filePath string) badger.Options
• type BadgerGCOptions
• type BadgerLogger
  • func NewBadgerLogger(ctx context.Context, callerSkip int) *BadgerLogger
  • func (l *BadgerLogger) Debugf(format string, v ...interface{})
  • func (l *BadgerLogger) Errorf(format string, v ...interface{})
  • func (l *BadgerLogger) Infof(format string, v ...interface{})
  • func (l *BadgerLogger) Warningf(format string, v ...interface{})
• type DB
  • func New(ctx context.Context, options badger.Options, dbOptions ...Option) (*DB, error)
  • func (t *DB) Close(ctx context.Context) error
  • func (t *DB) Commit(ctx context.Context, txn *badger.Txn) error
  • func (t *DB) DB() *badger.DB
  • func (t *DB) Delete(ctx context.Context, key []byte) error
  • func (t *DB) GC(ctx context.Context, options *BadgerGCOptions) error
  • func (t *DB) Get(ctx context.Context, txn *badger.Txn, key []byte) (value []byte, err error)
  • func (t *DB) MetricEnabled() bool
  • func (t *DB) NewTransaction(update bool) *badger.Txn
  • func (t *DB) TracingEnabled() bool
  • func (t *DB) Update(ctx context.Context, entry *badger.Entry) error
  • func (t *DB) View(ctx context.Context, key []byte, callback func([]byte) error) error
• type Option
  • func WithMetric(enabled bool) Option
  • func WithTracing(enabled bool) Option

Variables

var DefaultBadgerGCOptions = BadgerGCOptions{
	GCDiscardRatio: 0.5,
	GCInterval:     time.Minute * 5,
	GCSleep:        time.Second * 15,
}

Functions

func BadgerGC

func BadgerGC(ctx context.Context, extendedOptions *BadgerGCOptions, db *badger.DB)

func DefaultOptions

func DefaultOptions(ctx context.Context, filePath string) badger.Options

func LowMemLowCPUBadgerOptions

func LowMemLowCPUBadgerOptions(ctx context.Context, filePath string) badger.Options

func LowMemOptions

func LowMemOptions(ctx context.Context, filePath string) badger.Options

Types

type BadgerGCOptions

type BadgerGCOptions struct {
	GCDiscardRatio float64
	GCInterval     time.Duration
	GCSleep        time.Duration
}

type BadgerLogger

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

func NewBadgerLogger

func NewBadgerLogger(ctx context.Context, callerSkip int) *BadgerLogger

func (*BadgerLogger) Debugf

func (l *BadgerLogger) Debugf(format string, v ...interface{})

func (*BadgerLogger) Errorf

func (l *BadgerLogger) Errorf(format string, v ...interface{})

func (*BadgerLogger) Infof

func (l *BadgerLogger) Infof(format string, v ...interface{})

func (*BadgerLogger) Warningf

func (l *BadgerLogger) Warningf(format string, v ...interface{})

type DB

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

func New

func New(ctx context.Context, options badger.Options, dbOptions ...Option) (*DB, error)

func (*DB) Close

func (t *DB) Close(ctx context.Context) error

func (*DB) Commit

func (t *DB) Commit(ctx context.Context, txn *badger.Txn) error

func (*DB) DB

func (t *DB) DB() *badger.DB

func (*DB) Delete

func (t *DB) Delete(ctx context.Context, key []byte) error

func (*DB) GC

func (t *DB) GC(ctx context.Context, options *BadgerGCOptions) error

func (*DB) Get

func (t *DB) Get(ctx context.Context, txn *badger.Txn, key []byte) (value []byte, err error)

func (*DB) MetricEnabled

func (t *DB) MetricEnabled() bool

func (*DB) NewTransaction

func (t *DB) NewTransaction(update bool) *badger.Txn

func (*DB) TracingEnabled

func (t *DB) TracingEnabled() bool

func (*DB) Update

func (t *DB) Update(ctx context.Context, entry *badger.Entry) error

func (*DB) View

func (t *DB) View(ctx context.Context, key []byte, callback func([]byte) error) error

type Option

type Option = func(opt *option)

func WithMetric

func WithMetric(enabled bool) Option

func WithTracing

func WithTracing(enabled bool) Option