store

Documentation

Overview

Package store defines the primitives of a simple key/value storage.

Documentation Last Review: 08.10.2020

Index

• type Readable
• type Snapshot
• type Transaction
• type Writable

Types

type Readable

type Readable interface {
	Get(key []byte) ([]byte, error)
}

Readable is the interface for a readable store.

type Snapshot

type Snapshot interface {
	Readable
	Writable
}

Snapshot is a state of the store that can be read and write independently. A write is applied only to the snapshot reference.

type Transaction

type Transaction interface {
	// OnCommit adds a callback to be executed after the transaction
	// successfully commits.
	OnCommit(func())
}

Transaction is a generic interface that store implementations can use to provide atomicity.

type Writable

type Writable interface {
	Set(key []byte, value []byte) error

	// Delete deletes a given key.
	// It can return an error if deleting from a read-only store
	// No error is returned if the key does not exist.
	Delete(key []byte) error
}

Writable is the interface for a writable store.