storeapi

package

Go to main page

Versions in this module

v0

v0.31.0

Aug 22, 2026

v0.30.0

Aug 22, 2026

Changes in this version

+ var ErrInvalidCondition = errors.New("beehive: condition text must be valid UTF-8")

type Store

+ Identity func() string

v0.29.0

Aug 19, 2026

Changes in this version

+ var ErrDeletionPending = errors.New("beehive: object is deletion-pending")

v0.28.0

Aug 19, 2026

Changes in this version

type Objects

+ GetMetaByName func(ctx context.Context, gk GroupKind, name string) (*RawObject, error)

v0.27.0

Aug 19, 2026

v0.26.0

Aug 18, 2026

v0.25.0

Aug 18, 2026

v0.24.0

Aug 18, 2026

v0.23.0

Aug 13, 2026

v0.22.0

Aug 7, 2026

Changes in this version

type Condition

+ Unconfirmed bool

v0.21.0

Aug 7, 2026

Changes in this version

+ var ErrDuplicateConditionType = errors.New("beehive: condition type set twice in one write")

+ var ErrInvalidObservedGeneration = errors.New("beehive: observed generation is not a generation")

type Objects

+ SetObservedGeneration func(ctx context.Context, gk GroupKind, id ObjectID, observedGeneration int64) (settled bool, err error)

v0.20.0

Aug 7, 2026

Changes in this version

+ type Conditions interface

+ Delete func(ctx context.Context, gk GroupKind, id ObjectID, condType string) error

+ Set func(ctx context.Context, gk GroupKind, id ObjectID, cond Condition) error

+ type DeletionRequests interface

+ Create func(ctx context.Context, gk GroupKind, id ObjectID) (DeletionRequestResult, error)

+ CreateByName func(ctx context.Context, gk GroupKind, name string) (DeletionRequestResult, error)

+ CreateFromOwner func(ctx context.Context, ownerID ObjectID) (DeletionCascadeResult, error)

+ List func(ctx context.Context) ([]ObjectRef, error)

+ type Dependencies interface

+ ListStaleSince func(ctx context.Context, kinds []GroupKind, after StalePos, through int64, ...) ([]ObjectRef, StalePos, error)

+ WatermarkSet func(ctx context.Context, id ObjectID, cursor int64) error

+ type DriverCursors interface

+ Get func(ctx context.Context, name string) (cursor int64, ok bool, err error)

+ Set func(ctx context.Context, name string, cursor int64) error

+ type Edges interface

+ Add func(ctx context.Context, fromID, toID ObjectID, relation Relation) (EdgesAddResult, error)

+ Delete func(ctx context.Context, fromID, toID ObjectID, relation Relation) (EdgesDeleteResult, error)

+ DeleteFinalizingDependsOn func(ctx context.Context, toID ObjectID) error

+ GroupIncomingByID func(ctx context.Context, toIDs []ObjectID, relation Relation) (map[ObjectID][]ObjectRef, error)

+ GroupOutgoingByID func(ctx context.Context, fromIDs []ObjectID, relation Relation) (map[ObjectID][]ObjectRef, error)

+ HasIncoming func(ctx context.Context, id ObjectID) (bool, error)

+ ListIncoming func(ctx context.Context, toID ObjectID, relation Relation) ([]ObjectRef, error)

+ ListOutgoingByRelation func(ctx context.Context, fromID ObjectID, relation Relation) ([]ObjectRef, error)

+ type Events interface

+ Add func(ctx context.Context, gk GroupKind, id ObjectID, in EventsAddInput) error

+ GetLatest func(ctx context.Context, id ObjectID, category string) (*Event, error)

+ List func(ctx context.Context, id ObjectID, q EventQuery) ([]Event, error)

+ ListSince func(ctx context.Context, id ObjectID, category *string, afterRV int64, limit int) ([]Event, int64, error)

+ MaxVersion func(ctx context.Context, id ObjectID) (int64, error)

+ Snapshot func(ctx context.Context, id ObjectID, q EventQuery) ([]Event, int64, error)

+ Sweep func(ctx context.Context, perTimeline int, maxAge time.Duration, capBudget int) (int, error)

+ type ObjectWrites interface

+ ListSince func(ctx context.Context, gk GroupKind, afterRV int64, limit int) (page []ObjectWrite, trimmedThrough int64, err error)

+ ListSinceAll func(ctx context.Context, afterRV int64, limit int) (page []ObjectWrite, trimmedThrough int64, err error)

+ MaxVersion func(ctx context.Context, gk GroupKind) (int64, error)

+ MaxVersionAll func(ctx context.Context) (at int64, trimmedThrough int64, err error)

+ Snapshot func(ctx context.Context, gk GroupKind) ([]*RawObject, int64, error)

+ SnapshotByID func(ctx context.Context, gk GroupKind, id ObjectID) ([]*RawObject, int64, error)

+ SnapshotByOwner func(ctx context.Context, gk GroupKind, ownerID ObjectID) ([]*RawObject, int64, error)

+ Sweep func(ctx context.Context, perKind int, maxAge time.Duration) (int, error)

+ type Objects interface

+ Create func(ctx context.Context, gk GroupKind, in ObjectsCreateInput) (*RawObject, error)

+ Delete func(ctx context.Context, id ObjectID) error

+ DeleteFinalizer func(ctx context.Context, gk GroupKind, id ObjectID, finalizer string) (clearedLast bool, err error)

+ Get func(ctx context.Context, id ObjectID) (*RawObject, error)

+ GetByName func(ctx context.Context, gk GroupKind, name string) (*RawObject, error)

+ GetForReconcile func(ctx context.Context, id ObjectID) (ReconcileLoad, error)

+ GetMeta func(ctx context.Context, id ObjectID) (*RawObject, error)

+ List func(ctx context.Context, gk GroupKind) ([]*RawObject, error)

+ ListByIDs func(ctx context.Context, gk GroupKind, ids []ObjectID) ([]*RawObject, error)

+ ListByIncomingEdge func(ctx context.Context, gk GroupKind, toID ObjectID, relation Relation) ([]*RawObject, error)

+ ListIDs func(ctx context.Context, gk GroupKind) ([]ObjectID, error)

+ ListUnsettledIDs func(ctx context.Context, gk GroupKind) ([]ObjectID, error)

+ UpdateSpec func(ctx context.Context, gk GroupKind, id ObjectID, spec []byte, specVersion int) (obj *RawObject, changed bool, err error)

+ UpdateSpecByName func(ctx context.Context, gk GroupKind, name string, spec []byte, specVersion int) (obj *RawObject, changed bool, err error)

+ UpdateStatus func(ctx context.Context, gk GroupKind, id ObjectID, observedGeneration int64, ...) error

+ type ReconcileOwed interface

+ Decrement func(ctx context.Context, gk GroupKind, id ObjectID, observed int64) error

+ ListIDs func(ctx context.Context, gk GroupKind) ([]ObjectID, error)

+ Stamp func(ctx context.Context, refs []ObjectRef) error

+ Sweep func(ctx context.Context, keep []GroupKind) (int, error)

type Store

+ Conditions func() Conditions

+ DeletionRequests func() DeletionRequests

+ Dependencies func() Dependencies

+ DriverCursors func() DriverCursors

+ Edges func() Edges

+ Events func() Events

+ GetLatestResourceVersion func(ctx context.Context) (int64, error)

+ ObjectWrites func() ObjectWrites

+ Objects func() Objects

+ ReclaimSpace func(ctx context.Context, maxPages int) (int, error)

+ ReconcileOwed func() ReconcileOwed

v0.19.0

Aug 7, 2026

Changes in this version

+ var ErrConcurrentNestedTx = errors.New("beehive: nested transaction frame still open at commit")

+ var ErrInvalidName = errors.New("beehive: name must not be empty")

+ var ErrNameTaken = errors.New("beehive: name is already in use for this kind")

+ var ErrStaleTxContext = errors.New("beehive: transaction context is not the live frame")

type ChangeType

+ const Failed

+ type DeletionCascadeChild struct

+ Marked bool

+ Ref ObjectRef

+ type DeletionCascadeResult struct

+ Children []DeletionCascadeChild

+ Unblocked []ObjectRef

+ type DeletionRequestResult struct

+ ID ObjectID

+ Marked bool

+ Unblocked []ObjectRef

+ type DriverCursorer interface

+ DriverCursorsGet func(ctx context.Context, name string) (cursor int64, ok bool, err error)

+ DriverCursorsSet func(ctx context.Context, name string, cursor int64) error

+ type EdgesAddResult struct

+ From GroupKind

+ ReconcileOwedStamped bool

+ To GroupKind

+ ToDeleting bool

+ type EdgesDeleteResult struct

+ To GroupKind

+ Unblocked bool

type EventQuery

+ func (q EventQuery) Matches(e Event) bool

+ type EventsAddInput struct

+ Category string

+ Detail []byte

+ Message string

+ Reason string

+ Type string

+ type FreePagesReleaser interface

+ FreePagesRelease func(ctx context.Context, maxPages int) (int, error)

+ type ObjectRef struct

+ Group string

+ ID ObjectID

+ Kind string

+ func (r ObjectRef) GroupKind() GroupKind

+ type ObjectWrite struct

+ Final *RawObject

+ Group string

+ ID ObjectID

+ Kind string

+ Op WriteOp

+ ResourceVersion int64

+ type ObjectsCreateInput struct

+ Finalizers []string

+ Name string

+ Spec []byte

+ SpecVersion int

type RawObject

+ Name string

+ Owner *ObjectRef

+ ReconcileOwed int64

+ type ReconcileLoad struct

+ Cursor int64

+ HasDependencies bool

+ Object RawObject

+ type StalePos struct

+ DependentID ObjectID

+ TargetID ObjectID

+ TargetVersion int64

type Store

+ ConditionsDelete func(ctx context.Context, gk GroupKind, id ObjectID, condType string) error

+ ConditionsSet func(ctx context.Context, gk GroupKind, id ObjectID, cond Condition) error

+ DeletionRequestsCreate func(ctx context.Context, gk GroupKind, id ObjectID) (DeletionRequestResult, error)

+ DeletionRequestsCreateByName func(ctx context.Context, gk GroupKind, name string) (DeletionRequestResult, error)

+ DeletionRequestsCreateFromOwner func(ctx context.Context, ownerID ObjectID) (DeletionCascadeResult, error)

+ DeletionRequestsList func(ctx context.Context) ([]ObjectRef, error)

+ DependencyWatermarksSet func(ctx context.Context, id ObjectID, cursor int64) error

+ DependentsListStaleSince func(ctx context.Context, kinds []GroupKind, after StalePos, through int64, ...) ([]ObjectRef, StalePos, error)

+ EdgesAdd func(ctx context.Context, fromID, toID ObjectID, relation Relation) (EdgesAddResult, error)

+ EdgesDelete func(ctx context.Context, fromID, toID ObjectID, relation Relation) (EdgesDeleteResult, error)

+ EdgesDeleteFinalizingDependsOn func(ctx context.Context, toID ObjectID) error

+ EdgesGroupIncomingByID func(ctx context.Context, toIDs []ObjectID, relation Relation) (map[ObjectID][]ObjectRef, error)

+ EdgesGroupOutgoingByID func(ctx context.Context, fromIDs []ObjectID, relation Relation) (map[ObjectID][]ObjectRef, error)

+ EdgesHasIncoming func(ctx context.Context, id ObjectID) (bool, error)

+ EdgesListIncoming func(ctx context.Context, toID ObjectID, relation Relation) ([]ObjectRef, error)

+ EdgesListOutgoingByRelation func(ctx context.Context, fromID ObjectID, relation Relation) ([]ObjectRef, error)

+ EventsAdd func(ctx context.Context, gk GroupKind, id ObjectID, in EventsAddInput) error

+ EventsGetLatest func(ctx context.Context, id ObjectID, category string) (*Event, error)

+ EventsList func(ctx context.Context, id ObjectID, q EventQuery) ([]Event, error)

+ EventsListSince func(ctx context.Context, id ObjectID, category *string, afterRV int64, limit int) ([]Event, int64, error)

+ EventsMaxVersion func(ctx context.Context, id ObjectID) (int64, error)

+ EventsSnapshot func(ctx context.Context, id ObjectID, q EventQuery) ([]Event, int64, error)

+ EventsSweep func(ctx context.Context, perTimeline int, maxAge time.Duration, capBudget int) (int, error)

+ FinalizersDelete func(ctx context.Context, gk GroupKind, id ObjectID, finalizer string) (clearedLast bool, err error)

+ ObjectWritesListSince func(ctx context.Context, gk GroupKind, afterRV int64, limit int) (page []ObjectWrite, trimmedThrough int64, err error)

+ ObjectWritesListSinceAll func(ctx context.Context, afterRV int64, limit int) (page []ObjectWrite, trimmedThrough int64, err error)

+ ObjectWritesMaxVersion func(ctx context.Context, gk GroupKind) (int64, error)

+ ObjectWritesMaxVersionAll func(ctx context.Context) (at int64, trimmedThrough int64, err error)

+ ObjectWritesSnapshot func(ctx context.Context, gk GroupKind) ([]*RawObject, int64, error)

+ ObjectWritesSnapshotByID func(ctx context.Context, gk GroupKind, id ObjectID) ([]*RawObject, int64, error)

+ ObjectWritesSnapshotByOwner func(ctx context.Context, gk GroupKind, ownerID ObjectID) ([]*RawObject, int64, error)

+ ObjectWritesSweep func(ctx context.Context, perKind int, maxAge time.Duration) (int, error)

+ ObjectsCreate func(ctx context.Context, gk GroupKind, in ObjectsCreateInput) (*RawObject, error)

+ ObjectsDelete func(ctx context.Context, id ObjectID) error

+ ObjectsGet func(ctx context.Context, id ObjectID) (*RawObject, error)

+ ObjectsGetByName func(ctx context.Context, gk GroupKind, name string) (*RawObject, error)

+ ObjectsGetForReconcile func(ctx context.Context, id ObjectID) (ReconcileLoad, error)

+ ObjectsGetMeta func(ctx context.Context, id ObjectID) (*RawObject, error)

+ ObjectsList func(ctx context.Context, gk GroupKind) ([]*RawObject, error)

+ ObjectsListByIDs func(ctx context.Context, gk GroupKind, ids []ObjectID) ([]*RawObject, error)

+ ObjectsListByIncomingEdge func(ctx context.Context, gk GroupKind, toID ObjectID, relation Relation) ([]*RawObject, error)

+ ObjectsListIDs func(ctx context.Context, gk GroupKind) ([]ObjectID, error)

+ ObjectsListUnsettledIDs func(ctx context.Context, gk GroupKind) ([]ObjectID, error)

+ ObjectsUpdateSpec func(ctx context.Context, gk GroupKind, id ObjectID, spec []byte, specVersion int) (obj *RawObject, changed bool, err error)

+ ObjectsUpdateSpecByName func(ctx context.Context, gk GroupKind, name string, spec []byte, specVersion int) (obj *RawObject, changed bool, err error)

+ ObjectsUpdateStatus func(ctx context.Context, gk GroupKind, id ObjectID, observedGeneration int64, ...) error

+ ReconcileOwedDecrement func(ctx context.Context, gk GroupKind, id ObjectID, observed int64) error

+ ReconcileOwedListIDs func(ctx context.Context, gk GroupKind) ([]ObjectID, error)

+ ReconcileOwedStamp func(ctx context.Context, refs []ObjectRef) error

+ ReconcileOwedSweep func(ctx context.Context, keep []GroupKind) (int, error)

+ ResourceVersionsMaxIssued func(ctx context.Context) (int64, error)

+ type WriteOp int

+ const WriteCreate

+ const WriteDelete

+ const WriteUpdate

v0.18.0

Jul 23, 2026

Changes in this version

+ var ErrSchemaVersionDowngrade = errors.New("beehive: stored schema version is newer than this build's")

type Store

+ ListIncomingRefObjects func(ctx context.Context, gk GroupKind, toID ObjectID, relation Relation) ([]*RawObject, error)

+ RequestDeletionBySlug func(ctx context.Context, gk GroupKind, slug string) (obj *RawObject, changed bool, err error)

v0.17.0

Jul 22, 2026

Changes in this version

type Store

+ AfterCommit func(ctx context.Context, fn func(ctx context.Context))

v0.16.0

Jul 22, 2026

v0.15.0

Jul 21, 2026

v0.14.0

Jul 12, 2026

v0.13.0

Jul 2, 2026

v0.12.0

Jul 2, 2026

Changes in this version

+ type ChangeType string

+ const Added

+ const Deleted

+ const Modified

+ type RawChange struct

+ Object *RawObject

+ Type ChangeType

type Watcher

+ Changes func() <-chan RawChange

v0.11.0

Jul 1, 2026

Changes in this version

+ type Event struct

+ Category string

+ Count int

+ Detail []byte

+ FirstAt time.Time

+ ID EventID

+ LastAt time.Time

+ Message string

+ ObjectID ObjectID

+ Reason string

+ ResourceVersion int64

+ Type string

+ type EventID = int64

+ type EventQuery struct

+ Category *string

+ Limit int

+ Reason string

+ Since time.Time

+ Type string

+ type EventWatcher interface

+ Close func()

+ Events func() <-chan Event

type Store

+ GetLatestEvent func(ctx context.Context, id ObjectID, category string) (*Event, error)

+ ListEvents func(ctx context.Context, id ObjectID, q EventQuery) ([]Event, error)

+ RecordEvent func(ctx context.Context, gk GroupKind, id ObjectID, ev Event) (*Event, error)

+ SweepEvents func(ctx context.Context, perObject int, maxAge time.Duration) (int, error)

+ WatchChanges func(ctx context.Context, gk GroupKind) (Watcher, error)

v0.10.0

Jun 30, 2026

v0.9.0

Jun 30, 2026

v0.8.0

Jun 30, 2026

v0.7.0

Jun 29, 2026

v0.6.0

Jun 25, 2026

v0.5.0

Jun 25, 2026

v0.4.0

Jun 24, 2026

Changes in this version

type Store

+ GroupIncomingRefsByID func(ctx context.Context, toIDs []ObjectID, relation Relation) (map[ObjectID][]Referrer, error)

+ GroupOutgoingRefsByID func(ctx context.Context, fromIDs []ObjectID, relation Relation) (map[ObjectID][]Referrer, error)

+ ListOutgoingRefsByRelation func(ctx context.Context, fromID ObjectID, relation Relation) ([]Referrer, error)

v0.3.0

Jun 23, 2026

Changes in this version

type RawObject

+ SpecVersion int

+ StatusVersion int

v0.2.0

Jun 23, 2026

v0.1.0

Jun 22, 2026

v0.0.2

Jun 22, 2026

v0.0.1

Jun 21, 2026

Changes in this version

+ var ErrNotFound = errors.New("beehive: object not found")

+ var ErrObservedGenerationFuture = errors.New("beehive: observed generation exceeds current generation")

+ var ErrWrongKind = errors.New("beehive: object belongs to a different kind")

+ type Condition struct

+ Liveness bool

+ Message string

+ Reason string

+ Status string

+ TransitionedAt time.Time

+ Type string

+ UpdatedAt time.Time

+ type GroupKind struct

+ Group string

+ Kind string

+ type ObjectID = int64

+ type RawObject struct

+ Conditions []Condition

+ CreatedAt time.Time

+ DeletionRequestedAt *time.Time

+ Finalizers []string

+ Generation int64

+ Group string

+ ID ObjectID

+ Kind string

+ ObservedAt *time.Time

+ ObservedGeneration *int64

+ ResourceVersion int64

+ Slug *string

+ Spec []byte

+ Status []byte

+ UpdatedAt time.Time

+ type RawWatchEvent struct

+ Object *RawObject

+ Type WatchEventType

+ type Referrer struct

+ Group string

+ ID ObjectID

+ Kind string

+ type Relation string

+ const RelationDependsOn

+ const RelationOwnedBy

+ type Store interface

+ AddRef func(ctx context.Context, fromID, toID ObjectID, relation Relation) error

+ CreateObject func(ctx context.Context, obj *RawObject) (*RawObject, error)

+ DeleteCondition func(ctx context.Context, gk GroupKind, id ObjectID, condType string) (*RawObject, error)

+ DeleteFinalizer func(ctx context.Context, gk GroupKind, id ObjectID, finalizer string) (*RawObject, error)

+ DeleteFinalizingDependsOnRefs func(ctx context.Context, toID ObjectID) error

+ DeleteObject func(ctx context.Context, id ObjectID) error

+ DeleteRef func(ctx context.Context, fromID, toID ObjectID, relation Relation) error

+ GetObject func(ctx context.Context, id ObjectID) (*RawObject, error)

+ GetObjectBySlug func(ctx context.Context, gk GroupKind, slug string) (*RawObject, error)

+ GetObjectMeta func(ctx context.Context, id ObjectID) (*RawObject, error)

+ HasIncomingRefs func(ctx context.Context, id ObjectID) (bool, error)

+ ListAllDeletionPendingIDs func(ctx context.Context) ([]ObjectID, error)

+ ListDeletionPendingIDs func(ctx context.Context, gk GroupKind) ([]ObjectID, error)

+ ListIDs func(ctx context.Context, gk GroupKind) ([]ObjectID, error)

+ ListIncomingRefs func(ctx context.Context, toID ObjectID, relation Relation) ([]Referrer, error)

+ ListObjects func(ctx context.Context, gk GroupKind) ([]*RawObject, error)

+ ListOutgoingRefs func(ctx context.Context, fromID ObjectID) ([]Referrer, error)

+ ListUnsettledIDs func(ctx context.Context, gk GroupKind) ([]ObjectID, error)

+ MarkOwnedForDeletion func(ctx context.Context, ownerID ObjectID) ([]Referrer, error)

+ RequestDeletion func(ctx context.Context, gk GroupKind, id ObjectID) (obj *RawObject, changed bool, err error)

+ SetCondition func(ctx context.Context, gk GroupKind, id ObjectID, cond Condition) (*RawObject, error)

+ UpdateSpec func(ctx context.Context, gk GroupKind, id ObjectID, spec []byte) (*RawObject, error)

+ UpdateStatus func(ctx context.Context, gk GroupKind, id ObjectID, observedGeneration int64, ...) (*RawObject, error)

+ Watch func(ctx context.Context, gk GroupKind, id ObjectID) (Watcher, error)

+ WatchEvents func(ctx context.Context, gk GroupKind) (Watcher, error)

+ WatchList func(ctx context.Context, gk GroupKind) (Watcher, error)

+ Within func(ctx context.Context, fn func(ctx context.Context) error) error

+ type WatchEventType string

+ const WatchEventAdded

+ const WatchEventDeleted

+ const WatchEventModified

+ type Watcher interface

+ Close func()

+ Events func() <-chan RawWatchEvent

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