statedb

package module

Go to main page

Versions in this module

v0

v0.3.5

Dec 16, 2024

v0.3.4

Nov 14, 2024

Changes in this version

+ func DBCmd(db *DB) script.Cmd

v0.3.3

Oct 31, 2024

v0.3.2

Oct 22, 2024

Changes in this version

+ func WatchCmd(db *DB) script.Cmd

type AnyTable

+ func (t AnyTable) Changes(txn WriteTxn) (anyChangeIterator, error)

v0.3.1

Oct 10, 2024

Changes in this version

+ func CompareCmd(db *DB) script.Cmd

+ func DeleteCmd(db *DB) script.Cmd

+ func GetCmd(db *DB) script.Cmd

+ func InitializedCmd(db *DB) script.Cmd

+ func InsertCmd(db *DB) script.Cmd

+ func ListCmd(db *DB) script.Cmd

+ func LowerBoundCmd(db *DB) script.Cmd

+ func PrefixCmd(db *DB) script.Cmd

+ func ScriptCommands(db *DB) hive.ScriptCmdOut

+ func ShowCmd(db *DB) script.Cmd

+ func TablesCmd(db *DB) script.Cmd

+ type AnyTable struct

+ Meta TableMeta

+ func (t AnyTable) All(txn ReadTxn) iter.Seq2[any, Revision]

+ func (t AnyTable) AllWatch(txn ReadTxn) (iter.Seq2[any, Revision], <-chan struct{})

+ func (t AnyTable) Delete(txn WriteTxn, obj any) (old any, hadOld bool, err error)

+ func (t AnyTable) Get(txn ReadTxn, index string, key string) (any, Revision, bool, error)

+ func (t AnyTable) Insert(txn WriteTxn, obj any) (old any, hadOld bool, err error)

+ func (t AnyTable) List(txn ReadTxn, index string, key string) (iter.Seq2[any, Revision], error)

+ func (t AnyTable) LowerBound(txn ReadTxn, index string, key string) (iter.Seq2[any, Revision], error)

+ func (t AnyTable) Prefix(txn ReadTxn, index string, key string) (iter.Seq2[any, Revision], error)

+ func (t AnyTable) Proto() any

+ func (t AnyTable) TableHeader() []string

+ func (t AnyTable) UnmarshalYAML(data []byte) (any, error)

type DB

+ func (db *DB) GetTable(txn ReadTxn, name string) TableMeta

+ func (db *DB) GetTables(txn ReadTxn) (tbls []TableMeta)

type Index

+ FromString func(key string) (index.Key, error)

type TableMeta

+ Indexes func() []string

+ Initialized func(ReadTxn) (bool, <-chan struct{})

+ NumObjects func(ReadTxn) int

+ PendingInitializers func(ReadTxn) []string

+ Revision func(ReadTxn) Revision

v0.3.0

Sep 6, 2024

Changes in this version

+ func ToSeq[A, B any](seq iter.Seq2[A, B]) iter.Seq[A]

type ChangeIterator

+ Next func(ReadTxn) (iter.Seq2[Change[Obj], Revision], <-chan struct{})

v0.2.6

Sep 3, 2024

Changes in this version

type RemoteTable

+ func (t *RemoteTable[Obj]) Changes(ctx context.Context) (iter Iterator[Change[Obj]], errChan <-chan error)

v0.2.5

Aug 16, 2024

Changes in this version

type RWTable

+ Modify func(txn WriteTxn, new Obj, merge func(old, new Obj) Obj) (oldObj Obj, hadOld bool, err error)

v0.2.4

Aug 8, 2024

Changes in this version

+ var ErrTableNotRegistered = errors.New("table not registered")

v0.2.3

Jul 15, 2024

v0.2.2

Jul 12, 2024

v0.2.1

Jul 4, 2024

v0.2.0

Jul 4, 2024

Changes in this version

type Table

+ AllWatch func(ReadTxn) (Iterator[Obj], <-chan struct{})

+ LowerBoundWatch func(ReadTxn, Query[Obj]) (iter Iterator[Obj], watch <-chan struct{})

+ PrefixWatch func(ReadTxn, Query[Obj]) (iter Iterator[Obj], watch <-chan struct{})

v0.1.2

Jul 4, 2024

v0.1.1

Jun 21, 2024

v0.1.0

Jun 4, 2024

Changes in this version

+ const GraveyardIndex

+ const GraveyardIndexPos

+ const GraveyardRevisionIndex

+ const GraveyardRevisionIndexPos

+ const PrimaryIndexPos

+ const RevisionIndex

+ const RevisionIndexPos

+ const SecondaryIndexStartPos

+ var Cell = cell.Module("statedb", "In-memory transactional database", cell.Provide(newHiveDB))

+ var ErrDuplicateIndex = errors.New("index name already in use")

+ var ErrDuplicateTable = errors.New("table already exists")

+ var ErrObjectNotFound = errors.New("object not found")

+ var ErrPrimaryIndexNotUnique = errors.New("primary index not unique")

+ var ErrReservedPrefix = errors.New("index name uses reserved prefix '" + reservedIndexPrefix + "'")

+ var ErrRevisionNotEqual = errors.New("revision not equal")

+ var ErrTableNotLockedForWriting = errors.New("not locked for writing")

+ var ErrTransactionClosed = errors.New("transaction is closed")

+ func Collect[Obj any](iter Iterator[Obj]) []Obj

+ func Derive[In, Out any](jobName string, transform func(obj In, deleted bool) (Out, DeriveResult)) func(DeriveParams[In, Out])

+ func Observable[Obj any](db *DB, table Table[Obj]) stream.Observable[Change[Obj]]

+ func ProcessEach[Obj any, It Iterator[Obj]](iter It, fn func(Obj, Revision) error) (err error)

+ func RegisterTable[Obj any](db *DB, table RWTable[Obj]) error

+ type Change struct

+ Deleted bool

+ Object Obj

+ Revision Revision

+ type ChangeIterator interface

+ Close func()

+ Watch func(ReadTxn) <-chan struct{}

+ type DB struct

+ func New(options ...Option) *DB

+ func (db *DB) HTTPHandler() http.Handler

+ func (db *DB) NewHandle(name string) Handle

+ func (db *DB) ReadTxn() ReadTxn

+ func (db *DB) RegisterTable(table TableMeta, tables ...TableMeta) error

+ func (db *DB) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (db *DB) Start() error

+ func (db *DB) Stop() error

+ func (db *DB) WriteTxn(table TableMeta, tables ...TableMeta) WriteTxn

+ type DeriveParams struct

+ DB *DB

+ Health cell.Health

+ InTable Table[In]

+ Jobs job.Registry

+ Lifecycle cell.Lifecycle

+ OutTable RWTable[Out]

+ type DeriveResult int

+ const DeriveDelete

+ const DeriveInsert

+ const DeriveSkip

+ const DeriveUpdate

+ type DualIterator struct

+ func NewDualIterator[Obj any](left, right Iterator[Obj]) *DualIterator[Obj]

+ func (it *DualIterator[Obj]) Next() (obj Obj, revision uint64, fromLeft, ok bool)

+ type ExpVarMetrics struct

+ DeleteTrackerCountVar *expvar.Map

+ GraveyardCleaningDurationVar *expvar.Map

+ GraveyardLowWatermarkVar *expvar.Map

+ GraveyardObjectCountVar *expvar.Map

+ LockContentionVar *expvar.Map

+ ObjectCountVar *expvar.Map

+ RevisionVar *expvar.Map

+ WriteTxnAcquisitionVar *expvar.Map

+ WriteTxnDurationVar *expvar.Map

+ func NewExpVarMetrics(publish bool) *ExpVarMetrics

+ func (m *ExpVarMetrics) DeleteTrackerCount(name string, numTrackers int)

+ func (m *ExpVarMetrics) GraveyardCleaningDuration(name string, duration time.Duration)

+ func (m *ExpVarMetrics) GraveyardLowWatermark(name string, lowWatermark Revision)

+ func (m *ExpVarMetrics) GraveyardObjectCount(name string, numDeletedObjects int)

+ func (m *ExpVarMetrics) ObjectCount(name string, numObjects int)

+ func (m *ExpVarMetrics) Revision(name string, revision uint64)

+ func (m *ExpVarMetrics) String() (out string)

+ func (m *ExpVarMetrics) WriteTxnDuration(handle string, tables []string, acquire time.Duration)

+ func (m *ExpVarMetrics) WriteTxnTableAcquisition(handle string, tableName string, acquire time.Duration)

+ func (m *ExpVarMetrics) WriteTxnTotalAcquisition(handle string, tables []string, acquire time.Duration)

+ type Handle struct

+ func (h Handle) ReadTxn() ReadTxn

+ func (h Handle) WriteTxn(table TableMeta, tables ...TableMeta) WriteTxn

+ type Index struct

+ FromKey func(key Key) index.Key

+ FromObject func(obj Obj) index.KeySet

+ Name string

+ Unique bool

+ func (i Index[Obj, Key]) ObjectToKey(obj Obj) index.Key

+ func (i Index[Obj, Key]) Query(key Key) Query[Obj]

+ func (i Index[Obj, Key]) QueryFromObject(obj Obj) Query[Obj]

+ type IndexName = string

+ type Indexer interface

+ ObjectToKey func(Obj) index.Key

+ QueryFromObject func(Obj) Query[Obj]

+ type Iterator interface

+ Next func() (obj Obj, rev Revision, ok bool)

+ func Filter[Obj any, It Iterator[Obj]](iter It, pred func(Obj) bool) Iterator[Obj]

+ func Map[In, Out any, It Iterator[In]](iter It, transform func(In) Out) Iterator[Out]

+ type Metrics interface

+ DeleteTrackerCount func(tableName string, numTrackers int)

+ GraveyardCleaningDuration func(tableName string, duration time.Duration)

+ GraveyardLowWatermark func(tableName string, lowWatermark Revision)

+ GraveyardObjectCount func(tableName string, numDeletedObjects int)

+ ObjectCount func(tableName string, numObjects int)

+ Revision func(tableName string, revision Revision)

+ WriteTxnDuration func(handle string, tables []string, acquire time.Duration)

+ WriteTxnTableAcquisition func(handle string, tableName string, acquire time.Duration)

+ WriteTxnTotalAcquisition func(handle string, tables []string, acquire time.Duration)

+ type NopMetrics struct

+ func (*NopMetrics) DeleteTrackerCount(tableName string, numTrackers int)

+ func (*NopMetrics) GraveyardCleaningDuration(tableName string, duration time.Duration)

+ func (*NopMetrics) GraveyardLowWatermark(tableName string, lowWatermark uint64)

+ func (*NopMetrics) GraveyardObjectCount(tableName string, numDeletedObjects int)

+ func (*NopMetrics) ObjectCount(tableName string, numObjects int)

+ func (*NopMetrics) Revision(tableName string, revision uint64)

+ func (*NopMetrics) WriteTxnDuration(handle string, tables []string, acquire time.Duration)

+ func (*NopMetrics) WriteTxnTableAcquisition(handle string, tableName string, acquire time.Duration)

+ func (*NopMetrics) WriteTxnTotalAcquisition(handle string, tables []string, acquire time.Duration)

+ type Option func(*opts)

+ func WithMetrics(m Metrics) Option

+ type Query struct

+ func ByRevision[Obj any](rev uint64) Query[Obj]

+ type QueryRequest struct

+ Index string

+ Key string

+ LowerBound bool

+ Table string

+ type QueryResponse struct

+ Err string

+ Obj any

+ Rev uint64

+ type RWTable interface

+ CompareAndDelete func(WriteTxn, Revision, Obj) (oldObj Obj, hadOld bool, err error)

+ CompareAndSwap func(WriteTxn, Revision, Obj) (oldObj Obj, hadOld bool, err error)

+ Delete func(WriteTxn, Obj) (oldObj Obj, hadOld bool, err error)

+ DeleteAll func(WriteTxn) error

+ Insert func(WriteTxn, Obj) (oldObj Obj, hadOld bool, err error)

+ RegisterInitializer func(txn WriteTxn, name string) func(WriteTxn)

+ ToTable func() Table[Obj]

+ func MustNewTable[Obj any](tableName TableName, primaryIndexer Indexer[Obj], ...) RWTable[Obj]

+ func NewTable[Obj any](tableName TableName, primaryIndexer Indexer[Obj], ...) (RWTable[Obj], error)

+ type ReadTxn interface

+ WriteJSON func(w io.Writer, tables ...string) error

+ type RemoteTable struct

+ func NewRemoteTable[Obj any](base *url.URL, table TableName) *RemoteTable[Obj]

+ func (t *RemoteTable[Obj]) Get(ctx context.Context, q Query[Obj]) (Iterator[Obj], <-chan error)

+ func (t *RemoteTable[Obj]) LowerBound(ctx context.Context, q Query[Obj]) (Iterator[Obj], <-chan error)

+ func (t *RemoteTable[Obj]) SetTransport(tr *http.Transport)

+ type Revision = uint64

+ type Table interface

+ All func(ReadTxn) (Iterator[Obj], <-chan struct{})

+ Changes func(WriteTxn) (ChangeIterator[Obj], error)

+ Get func(ReadTxn, Query[Obj]) (obj Obj, rev Revision, found bool)

+ GetWatch func(ReadTxn, Query[Obj]) (obj Obj, rev Revision, watch <-chan struct{}, found bool)

+ Initialized func(ReadTxn) bool

+ List func(ReadTxn, Query[Obj]) Iterator[Obj]

+ ListWatch func(ReadTxn, Query[Obj]) (Iterator[Obj], <-chan struct{})

+ LowerBound func(ReadTxn, Query[Obj]) (iter Iterator[Obj], watch <-chan struct{})

+ NumObjects func(ReadTxn) int

+ PendingInitializers func(ReadTxn) []string

+ Prefix func(ReadTxn, Query[Obj]) (iter Iterator[Obj], watch <-chan struct{})

+ PrimaryIndexer func() Indexer[Obj]

+ Revision func(ReadTxn) Revision

+ type TableMeta interface

+ Name func() TableName

+ type TableName = string

+ type TableWritable interface

+ TableHeader func() []string

+ TableRow func() []string

+ type WriteTxn interface

+ Abort func()

+ Commit func() ReadTxn

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL