kv

Documentation

Index

• Variables
• func BatchWrite(e *badger.Entry)
• func DB() *badger.DB
• func Index() *buntdb.DB
• func Init(config Config) error
• func MustInit(config Config)
• func Update(fn func(txn *badger.Txn) error) (err error)
• func UpdateIndex(fn func(tx *buntdb.Tx) error) (err error)
• func View(fn func(txn *badger.Txn) error) (err error)
• func ViewIndex(fn func(tx *buntdb.Tx) error) error
• type Allocator
  • func NewAllocator() *Allocator
  • func (bk *Allocator) GenKey(v ...interface{}) []byte
  • func (bk *Allocator) GenValue(m proto.Message) []byte
  • func (bk *Allocator) ReleaseAll()
• type Config
• type IterOption
  • func NewIterOption() *IterOption
  • func (o *IterOption) Backward() bool
  • func (o *IterOption) OffsetKey() []byte
  • func (o *IterOption) OnClose(key []byte)
  • func (o *IterOption) SetBackward() *IterOption
  • func (o *IterOption) SetForward() *IterOption
  • func (o *IterOption) SetOffsetKey(offset []byte) *IterOption
  • func (o *IterOption) SetOnClose(f func(key []byte)) *IterOption
• type ListOption
  • func NewListOption() *ListOption
  • func (o *ListOption) Backward() bool
  • func (o *ListOption) Limit() int32
  • func (o *ListOption) SetBackward() *ListOption
  • func (o *ListOption) SetForward() *ListOption
  • func (o *ListOption) SetLimit(limit int32) *ListOption
  • func (o *ListOption) SetSkip(skip int32) *ListOption
  • func (o *ListOption) Skip() int32

Variables

var (
	DefaultConfig = Config{
		DirPath:             "./_hdd",
		ConflictRetries:     100,
		ConflictMaxInterval: time.Millisecond,
		BatchSize:           defaultBatchSize,
		BatchWorkers:        defaultBatchWorkers,
	}
)

Functions

func BatchWrite

func BatchWrite(e *badger.Entry)

BatchWrite is the helper function to set the entry backed by an internal flusher. Which makes writes faster but there is no guarantee that write has been done successfully, since we bypass the errors. TODO:: Maybe improve the flusher structure to return error in the case

func DB

func DB() *badger.DB

DB returns the underlying object of the database

func Index

func Index() *buntdb.DB

Index returns the underlying object of the index db

func Init

func Init(config Config) error

func MustInit

func MustInit(config Config)

func Update

func Update(fn func(txn *badger.Txn) error) (err error)

Update executes a function, creating and managing a read-write transaction for the user. Error returned by the function is relayed by the Update method. It retries in case of badger.ErrConflict returned.

func UpdateIndex

func UpdateIndex(fn func(tx *buntdb.Tx) error) (err error)

UpdateIndex executes a function within a managed read/write transaction. The transaction has been committed when no error is returned. In the event that an error is returned, the transaction will be rolled back. When a non-nil error is returned from the function, the transaction will be rolled back and the that error will be return to the caller of UpdateIndex().

Executing a manual commit or rollback from inside the function will result in a panic.

func View

func View(fn func(txn *badger.Txn) error) (err error)

View executes a function creating and managing a read-only transaction for the user. Error returned by the function is relayed by the View method. It retries in case of badger.ErrConflict returned.

func ViewIndex

func ViewIndex(fn func(tx *buntdb.Tx) error) error

ViewIndex executes a function within a managed read-only transaction. When a non-nil error is returned from the function that error will be return to the caller of ViewIndex().

Executing a manual commit or rollback from inside the function will result in a panic.

Types

type Allocator

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

func NewAllocator

func NewAllocator() *Allocator

func (*Allocator) GenKey

func (bk *Allocator) GenKey(v ...interface{}) []byte

func (*Allocator) GenValue

func (bk *Allocator) GenValue(m proto.Message) []byte

func (*Allocator) ReleaseAll

func (bk *Allocator) ReleaseAll()

type Config

type Config struct {
	DirPath             string
	ConflictRetries     int
	ConflictMaxInterval time.Duration
	BatchWorkers        int
	BatchSize           int
}

type IterOption

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

func NewIterOption

func NewIterOption() *IterOption

func (*IterOption) Backward

func (o *IterOption) Backward() bool

func (*IterOption) OffsetKey

func (o *IterOption) OffsetKey() []byte

func (*IterOption) OnClose

func (o *IterOption) OnClose(key []byte)

func (*IterOption) SetBackward

func (o *IterOption) SetBackward() *IterOption

func (*IterOption) SetForward

func (o *IterOption) SetForward() *IterOption

func (*IterOption) SetOffsetKey

func (o *IterOption) SetOffsetKey(offset []byte) *IterOption

func (*IterOption) SetOnClose

func (o *IterOption) SetOnClose(f func(key []byte)) *IterOption

type ListOption

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

func NewListOption

func NewListOption() *ListOption

func (*ListOption) Backward

func (o *ListOption) Backward() bool

func (*ListOption) Limit

func (o *ListOption) Limit() int32

func (*ListOption) SetBackward

func (o *ListOption) SetBackward() *ListOption

func (*ListOption) SetForward

func (o *ListOption) SetForward() *ListOption

func (*ListOption) SetLimit

func (o *ListOption) SetLimit(limit int32) *ListOption

func (*ListOption) SetSkip

func (o *ListOption) SetSkip(skip int32) *ListOption

func (*ListOption) Skip

func (o *ListOption) Skip() int32