cache

Documentation

Index

• Constants
• Variables
• type Cache
  • func NewFileCache(dir string) Cache
  • func NewInMemoryCache() Cache
• type HistoryCache
  • func NewHistoryFileCache(dir string) HistoryCache

Constants

const (
	IDENTITY_FN = ".identity-"
)

const STATE_FN = ".state-"

STATE_FN ...

Variables

var (
	ErrPrevStateNotFound   = errors.New("could not find previous state")
	ErrLocalStateCorrupted = errors.New("local state is corrupted")
)

var ErrCacheAlreadyLocked = errors.New("cache is already locked")

var ErrCacheNotLocked = errors.New("cache is not locked")

var ErrServerIdentityValidationFailed = errors.New("failed to validate the identity of the server")

Types

type Cache

type Cache interface {
	Get(serverUUID, db string) (*schema.ImmutableState, error)
	Set(serverUUID, db string, state *schema.ImmutableState) error
	Lock(serverUUID string) error
	Unlock() error

	// ServerIdentityCheck check validates that a server with given identity can use given server uuid
	//
	// `serverIdentity` must uniquely identify given immudb server instance.
	// Go SDK passes `host:port` pair as the server identity however the Cache interface implementation
	// must not do any assumptions about the structure of this data.
	ServerIdentityCheck(serverIdentity, serverUUID string) error
}

Cache the cache interface

func NewFileCache

func NewFileCache(dir string) Cache

NewFileCache returns a new file cache

func NewInMemoryCache

func NewInMemoryCache() Cache

NewInMemoryCache returns a new in-memory cache

type HistoryCache

type HistoryCache interface {
	Cache
	Walk(serverUUID string, db string, f func(*schema.ImmutableState) interface{}) ([]interface{}, error)
}

HistoryCache the history cache interface

func NewHistoryFileCache

func NewHistoryFileCache(dir string) HistoryCache

NewHistoryFileCache returns a new history file cache