storage

Documentation

Index

• Variables
• func CommitTransaction(ctx context.Context) error
• func IsError(err error) bool
• func IsErrorCode(err error, code Code) bool
• func IsTransactionRegistered(ctx context.Context) bool
• func IsTransactional(ctx context.Context) bool
• func OnTransactionCommitted(ctx context.Context, callback func())
• func RegisterTransaction(ctx context.Context, transaction any, commitFn func(ctx context.Context) error, ...)
• func RegisteredTransaction(ctx context.Context) any
• func RollbackTransaction(ctx context.Context) error
• func TransactionalContext(ctx context.Context) context.Context
• type Code
• type Driver
• type Error
  • func NewError(code Code, originalError error) *Error
  • func (e Error) Error() string
  • func (e Error) Is(err error) bool
• type LedgerStore
• type LedgerStoreProvider
• type LedgerStoreProviderFn
  • func (fn LedgerStoreProviderFn[STORE]) GetLedgerStore(ctx context.Context, name string, create bool) (STORE, bool, error)
• type SystemStore

Variables

var (
	ErrConfigurationNotFound = errors.New("configuration not found")
)

var (
	ErrLedgerStoreNotFound = errors.New("ledger store not found")
)

Functions

func CommitTransaction

func CommitTransaction(ctx context.Context) error

func IsError

func IsError(err error) bool

func IsErrorCode

func IsErrorCode(err error, code Code) bool

func IsTransactionRegistered

func IsTransactionRegistered(ctx context.Context) bool

func IsTransactional

func IsTransactional(ctx context.Context) bool

func OnTransactionCommitted

func OnTransactionCommitted(ctx context.Context, callback func())

func RegisterTransaction

func RegisterTransaction(ctx context.Context, transaction any,
	commitFn func(ctx context.Context) error, rollbackFn func(ctx context.Context) error)

func RegisteredTransaction

func RegisteredTransaction(ctx context.Context) any

func RollbackTransaction

func RollbackTransaction(ctx context.Context) error

func TransactionalContext

func TransactionalContext(ctx context.Context) context.Context

Types

type Code

type Code string

const (
	ConstraintFailed Code = "CONSTRAINT_FAILED"
	ConstraintTXID   Code = "CONSTRAINT_TXID"
	TooManyClient    Code = "TOO_MANY_CLIENT"
)

type Driver

type Driver[STORE any] interface {
	LedgerStoreProvider[STORE]
	Initialize(ctx context.Context) error
	Close(ctx context.Context) error
	Name() string

	GetSystemStore() SystemStore
}

type Error

type Error struct {
	Code          Code
	OriginalError error
}

func NewError

func NewError(code Code, originalError error) *Error

func (Error) Error

func (e Error) Error() string

func (Error) Is

func (e Error) Is(err error) bool

type LedgerStore

type LedgerStore interface {
	Delete(ctx context.Context) error
	Initialize(ctx context.Context) (bool, error)
	Close(ctx context.Context) error
}

type LedgerStoreProvider

type LedgerStoreProvider[STORE any] interface {
	GetLedgerStore(ctx context.Context, name string, create bool) (STORE, bool, error)
}

type LedgerStoreProviderFn

type LedgerStoreProviderFn[STORE any] func(ctx context.Context, name string, create bool) (STORE, bool, error)

func (LedgerStoreProviderFn[STORE]) GetLedgerStore

func (fn LedgerStoreProviderFn[STORE]) GetLedgerStore(ctx context.Context, name string, create bool) (STORE, bool, error)

type SystemStore

type SystemStore interface {
	GetConfiguration(ctx context.Context, key string) (string, error)
	InsertConfiguration(ctx context.Context, key, value string) error
	ListLedgers(ctx context.Context) ([]string, error)
	DeleteLedger(ctx context.Context, name string) error
}