Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

kvstore

package

Go to main page

Versions in this module

v1

v1.3.9

May 20, 2024

v1.3.8

May 1, 2024

v1.3.7

Apr 29, 2024

Changes in this version

type Logger

+ func (this *Logger) Errorf(format string, args ...any)

type Store

+ func NewStoreWithPath(path string) (*Store, error)

+ func (this *Store) Path() string

v1.3.6

Apr 22, 2024

v1.3.5

Apr 21, 2024

Changes in this version

+ var DefaultWriteSyncOptions = &pebble.WriteOptions

+ var ErrSkip = errors.New("skip")

+ var ErrTableClosed = errors.New("table closed")

+ func IsNotFound(err error) bool

+ func IsSkipError(err error) bool

+ func NewTableClosedErr(tableName string) error

+ func Skip() (bool, error)

type DB

+ func (this *DB) Inspect(fn func(key []byte, value []byte)) error

+ func (this *DB) Truncate() error

+ type NilValueEncoder struct

+ func NewNilValueEncoder[T []byte]() *NilValueEncoder[T]

+ func (this *NilValueEncoder[T]) Decode(valueData []byte) (value T, err error)

+ func (this *NilValueEncoder[T]) Encode(value T) ([]byte, error)

+ func (this *NilValueEncoder[T]) EncodeField(value T, fieldName string) ([]byte, error)

type Store

+ func DefaultStore() (*Store, error)

+ func (this *Store) Flush() error

type Table

+ func (this *Table[T]) DeleteRange(start string, end string) error

+ func (this *Table[T]) Encoder() ValueEncoder[T]

+ func (this *Table[T]) Insert(key string, value T) error

+ func (this *Table[T]) SetSync(key string, value T) error

+ func (this *Table[T]) WriteTxSync(fn func(tx *Tx[T]) error) error

type Tx

+ func (this *Tx[T]) CommitSync() (err error)

+ func (this *Tx[T]) Insert(key string, value T) error

+ func (this *Tx[T]) SetSync(key string, value T) error

v1.3.4

Mar 24, 2024

Changes in this version

+ const FieldPrefix

+ const KeyMaxLength

+ const KeyPrefix

+ const MaxBatchKeys

+ const StoreSuffix

+ var DefaultWriteOptions = &pebble.WriteOptions

+ var ErrKeyTooLong = errors.New("too long key")

+ var ErrTableNotFound = errors.New("table not found")

+ func IsKeyNotFound(err error) bool

+ func IsValidName(name string) bool

+ func RemoveStore(path string) error

+ type BaseObjectEncoder struct

+ func (this *BaseObjectEncoder[T]) Decode(valueData []byte) (value T, err error)

+ func (this *BaseObjectEncoder[T]) Encode(value T) ([]byte, error)

+ type BoolValueEncoder struct

+ func NewBoolValueEncoder[T bool]() *BoolValueEncoder[T]

+ func (this *BoolValueEncoder[T]) Decode(valueData []byte) (value T, err error)

+ func (this *BoolValueEncoder[T]) Encode(value T) ([]byte, error)

+ func (this *BoolValueEncoder[T]) EncodeField(value T, fieldName string) ([]byte, error)

+ type BytesValueEncoder struct

+ func NewBytesValueEncoder[T []byte]() *BytesValueEncoder[T]

+ func (this *BytesValueEncoder[T]) Decode(valueData []byte) (value T, err error)

+ func (this *BytesValueEncoder[T]) Encode(value T) ([]byte, error)

+ func (this *BytesValueEncoder[T]) EncodeField(value T, fieldName string) ([]byte, error)

+ type CounterTable struct

+ func NewCounterTable[T int64 | uint64](name string) (*CounterTable[T], error)

+ func (this *CounterTable[T]) Increase(key string, delta T) (newValue T, err error)

+ type DB struct

+ func NewDB(store *Store, dbName string) (*DB, error)

+ func (this *DB) AddTable(table TableInterface)

+ func (this *DB) Close() error

+ func (this *DB) Name() string

+ func (this *DB) Namespace() string

+ func (this *DB) Store() *Store

+ type DataType = int

+ const DataTypeField

+ const DataTypeKey

+ type IntValueEncoder struct

+ func NewIntValueEncoder[T constraints.Integer]() *IntValueEncoder[T]

+ func (this *IntValueEncoder[T]) Decode(valueData []byte) (value T, err error)

+ func (this *IntValueEncoder[T]) Encode(value T) (data []byte, err error)

+ func (this *IntValueEncoder[T]) EncodeField(value T, fieldName string) ([]byte, error)

+ type Item struct

+ FieldKey []byte

+ Key string

+ Value T

+ type IteratorFunc func(tx *Tx[T], item Item[T]) (goNext bool, err error)

+ type IteratorOptions struct

+ LowerBound []byte

+ UpperBound []byte

+ func (this *IteratorOptions) RawOptions() *pebble.IterOptions

+ type Logger struct

+ func NewLogger() *Logger

+ func (this *Logger) Fatalf(format string, args ...any)

+ func (this *Logger) Infof(format string, args ...any)

+ type Query struct

+ func NewQuery[T any]() *Query[T]

+ func (this *Query[T]) Desc() *Query[T]

+ func (this *Query[T]) FieldAsc(fieldName string) *Query[T]

+ func (this *Query[T]) FieldDesc(fieldName string) *Query[T]

+ func (this *Query[T]) FieldOffset(fieldOffset []byte) *Query[T]

+ func (this *Query[T]) FieldPrefix(fieldName string, fieldPrefix string) *Query[T]

+ func (this *Query[T]) FindAll(fn IteratorFunc[T]) (err error)

+ func (this *Query[T]) ForField() *Query[T]

+ func (this *Query[T]) ForKey() *Query[T]

+ func (this *Query[T]) ForUpdate() *Query[T]

+ func (this *Query[T]) KeysOnly() *Query[T]

+ func (this *Query[T]) Limit(limit int) *Query[T]

+ func (this *Query[T]) Offset(offsetKey string) *Query[T]

+ func (this *Query[T]) Prefix(prefix string) *Query[T]

+ func (this *Query[T]) SetTable(table *Table[T]) *Query[T]

+ func (this *Query[T]) SetTx(tx *Tx[T]) *Query[T]

+ type QueryOperator int

+ const QueryOperatorGt

+ const QueryOperatorGte

+ const QueryOperatorLt

+ const QueryOperatorLte

+ type QueryOperatorInfo struct

+ Operator QueryOperator

+ Value any

+ type Store struct

+ func NewStore(storeName string) (*Store, error)

+ func OpenStore(storeName string) (*Store, error)

+ func OpenStoreDir(dir string, storeName string) (*Store, error)

+ func (this *Store) Close() error

+ func (this *Store) Delete(keyBytes []byte) error

+ func (this *Store) Get(keyBytes []byte) (valueBytes []byte, closer io.Closer, err error)

+ func (this *Store) IsClosed() bool

+ func (this *Store) NewDB(dbName string) (*DB, error)

+ func (this *Store) Open() error

+ func (this *Store) RawDB() *pebble.DB

+ func (this *Store) Set(keyBytes []byte, valueBytes []byte) error

+ type StringValueEncoder struct

+ func NewStringValueEncoder[T string]() *StringValueEncoder[T]

+ func (this *StringValueEncoder[T]) Decode(valueData []byte) (value T, err error)

+ func (this *StringValueEncoder[T]) Encode(value T) ([]byte, error)

+ func (this *StringValueEncoder[T]) EncodeField(value T, fieldName string) ([]byte, error)

+ type Table struct

+ func NewTable[T any](tableName string, encoder ValueEncoder[T]) (*Table[T], error)

+ func (this *Table[T]) AddField(fieldName string) error

+ func (this *Table[T]) AddFields(fieldName ...string) error

+ func (this *Table[T]) Close() error

+ func (this *Table[T]) ComposeFieldKey(keyBytes []byte, fieldName string, fieldValueBytes []byte) []byte

+ func (this *Table[T]) Count() (int64, error)

+ func (this *Table[T]) DB() *DB

+ func (this *Table[T]) DecodeFieldKey(fieldName string, fieldKey []byte) (fieldValue []byte, key []byte, err error)

+ func (this *Table[T]) Delete(key ...string) error

+ func (this *Table[T]) DropField(fieldName string) error

+ func (this *Table[T]) Exist(key string) (found bool, err error)

+ func (this *Table[T]) FieldKey(fieldName string) []byte

+ func (this *Table[T]) FullKey(realKey string) []byte

+ func (this *Table[T]) FullKeyBytes(realKeyBytes []byte) []byte

+ func (this *Table[T]) Get(key string) (value T, err error)

+ func (this *Table[T]) Name() string

+ func (this *Table[T]) Namespace() []byte

+ func (this *Table[T]) Query() *Query[T]

+ func (this *Table[T]) ReadTx(fn func(tx *Tx[T]) error) error

+ func (this *Table[T]) Set(key string, value T) error

+ func (this *Table[T]) SetDB(db *DB)

+ func (this *Table[T]) SetNamespace(namespace []byte)

+ func (this *Table[T]) Truncate() error

+ func (this *Table[T]) WriteTx(fn func(tx *Tx[T]) error) error

+ type TableInterface interface

+ Close func() error

+ Name func() string

+ SetDB func(db *DB)

+ SetNamespace func(namespace []byte)

+ type Tx struct

+ func NewTx[T any](table *Table[T], readOnly bool) *Tx[T]

+ func (this *Tx[T]) Close() error

+ func (this *Tx[T]) Commit() (err error)

+ func (this *Tx[T]) Delete(key string) error

+ func (this *Tx[T]) Get(key string) (value T, err error)

+ func (this *Tx[T]) NewIterator(opt *IteratorOptions) (*pebble.Iterator, error)

+ func (this *Tx[T]) Query() *Query[T]

+ func (this *Tx[T]) Set(key string, value T) error

+ type ValueEncoder interface

+ Decode func(valueBytes []byte) (value T, err error)

+ Encode func(value T) ([]byte, error)

+ EncodeField func(value T, fieldName string) ([]byte, error)