kv

Documentation

Index

• Constants
• Variables
• func NewErrObjectNotExist(key kv.Key) error
• type HeaderType
• type Key
  • func NewKeyWith(header KeyHeader, key Key) Key
• type KeyHeader
• type LimitOption
  • func NewLimitOption(limit int) *LimitOption
• type Object
  • func NewObject(key Key, value []byte) Object
• type OffsetOption
  • func NewOffsetOption(offset uint) *OffsetOption
• type Option
• type Order
• type OrderOption
  • func NewOrderOptionWith(order Order) *OrderOption
• type ResultSet
• type Store
• type Transaction

Constants

const (
	OrderNone = Order(0)
	OrderAsc  = Order(1)
	OrderDesc = Order(2)
)

Order options.

Variables

var CollectionKeyHeader = kv.CollectionKeyHeader

var DatabaseKeyHeader = kv.DatabaseKeyHeader

var DocumentKeyHeader = kv.DocumentKeyHeader

var ErrNotExist = document.ErrNotExist

var NoLimit = int(0)

NoLimit represents a no limit option.

var NoOffset = uint(0)

NoOffset represents a no offset option.

var PrimaryIndexHeader = kv.PrimaryIndexHeader

var SecondaryIndexHeader = kv.SecondaryIndexHeader

Functions

func NewErrObjectNotExist

func NewErrObjectNotExist(key kv.Key) error

Types

type HeaderType

type HeaderType = kv.HeaderType

KeyHeader represents a key header in the key-value store.

type Key

type Key = kv.Key

Key represents a key in the key-value store.

func NewKeyWith

func NewKeyWith(header KeyHeader, key Key) Key

NewKeyWith returns a new key from the specified header and key elements.

type KeyHeader

type KeyHeader = kv.KeyHeader

KeyHeader represents a header for all keys.

type LimitOption

type LimitOption struct {
	Limit int
}

LimitOption represents a limit option.

func NewLimitOption

func NewLimitOption(limit int) *LimitOption

NewLimitOption returns a new limit option.

type Object

type Object interface {
	// Key returns a key of the object.
	Key() Key
	// Value returns a value of the object.
	Value() []byte
}

Object reprease a key-value object.

func NewObject

func NewObject(key Key, value []byte) Object

NewObject returns a new object.

type OffsetOption

type OffsetOption struct {
	Offset uint
}

OffsetOption represents an offset option.

func NewOffsetOption

func NewOffsetOption(offset uint) *OffsetOption

NewLimitOption returns a new offset option.

type Option

type Option = any

Option represents a option.

type Order

type Order = int

Order represents a order.

type OrderOption

type OrderOption struct {
	Order Order
}

OrderOption represents a order option.

func NewOrderOptionWith

func NewOrderOptionWith(order Order) *OrderOption

NewOrderOptionWith returns a new order option.

type ResultSet

type ResultSet interface {
	// Next moves the cursor forward next object from its current position.
	Next() bool
	// Object returns an object in the current cursor.
	Object() (Object, error)
}

ResultSet represents a result set which includes query execution results.

type Store

type Store interface {
	document.KeyCoder
	// SetKeyCoder sets the key coder.
	SetKeyCoder(coder document.KeyCoder)
	// Transact begin a new transaction.
	Transact(write bool) (Transaction, error)
}

Store represents a store interface.

type Transaction

type Transaction interface {
	// Set stores a key-value object. If the key already holds some value, it is overwritten.
	Set(obj Object) error
	// Get returns a key-value object of the specified key.
	Get(key Key) (Object, error)
	// GetRange returns a result set of the specified key.
	GetRange(key Key, opts ...Option) (ResultSet, error)
	// Remove removes the specified key-value object.
	Remove(key Key) error
	// RemoveRange removes the specified key-value objects.
	RemoveRange(key Key) error
	// Commit commits this transaction.
	Commit() error
	// Cancel cancels this transaction.
	Cancel() error
	// SetTimeout sets the timeout of this transaction.
	SetTimeout(t time.Duration) error
}

Transaction represents a transaction interface.