atomic

Documentation

Index

• Variables
• type AtomicKV
  • func NewAtomicKV(store kv.KVStore) (*AtomicKV, error)
  • func (k *AtomicKV) Apply(ctx context.Context, changes []byte) error
  • func (k *AtomicKV) BeginApply(ctx context.Context) error
  • func (k *AtomicKV) BeginCommit(ctx context.Context) error
  • func (k *AtomicKV) Cancel(ctx context.Context) error
  • func (k *AtomicKV) Delete(key []byte) error
  • func (k *AtomicKV) EndApply(ctx context.Context) error
  • func (k *AtomicKV) EndCommit(ctx context.Context, appender func([]byte) error) (err error)
  • func (k *AtomicKV) Get(key []byte) ([]byte, error)
  • func (k *AtomicKV) ID(ctx context.Context) ([]byte, error)
  • func (k *AtomicKV) NewPrefix(prefix []byte) *AtomicKV
  • func (k *AtomicKV) Set(key []byte, value []byte) error

Variables

var (
	ErrSessionActive    = errors.New("session already active")
	ErrSessionNotActive = errors.New("session not active")
	ErrTxnActive        = errors.New("transaction already active")
	ErrTxnNotActive     = errors.New("transaction not active")
)

Types

type AtomicKV

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

AtomicKV is a threadsafe, linearizable key/value store.

func NewAtomicKV

func NewAtomicKV(store kv.KVStore) (*AtomicKV, error)

NewAtomicKV creates a new atomic key value store. It is compatible with Kwil's 2pc protocol.

func (*AtomicKV) Apply

func (k *AtomicKV) Apply(ctx context.Context, changes []byte) error

func (*AtomicKV) BeginApply

func (k *AtomicKV) BeginApply(ctx context.Context) error

func (*AtomicKV) BeginCommit

func (k *AtomicKV) BeginCommit(ctx context.Context) error

func (*AtomicKV) Cancel

func (k *AtomicKV) Cancel(ctx context.Context) error

func (*AtomicKV) Delete

func (k *AtomicKV) Delete(key []byte) error

Delete deletes a key from the database.

func (*AtomicKV) EndApply

func (k *AtomicKV) EndApply(ctx context.Context) error

func (*AtomicKV) EndCommit

func (k *AtomicKV) EndCommit(ctx context.Context, appender func([]byte) error) (err error)

func (*AtomicKV) Get

func (k *AtomicKV) Get(key []byte) ([]byte, error)

Read reads a key from the database.

func (*AtomicKV) ID

func (k *AtomicKV) ID(ctx context.Context) ([]byte, error)

func (*AtomicKV) NewPrefix

func (k *AtomicKV) NewPrefix(prefix []byte) *AtomicKV

NewPrefix creates a new writer with a prefix for the current store.

func (*AtomicKV) Set

func (k *AtomicKV) Set(key []byte, value []byte) error

Write writes a key/value pair to the database.