datastore

package

Go to main page

Versions in this module

v0

v0.0.3

Oct 22, 2024

Changes in this version

+ func DeleteAllData(ctx context.Context, ds Datastore) error

+ func NewMaximumChangesSizeExceededError(maxSize uint64) error

type Feature

+ Status FeatureStatus

+ type FeatureStatus int

+ const FeatureStatusUnknown

+ const FeatureSupported

+ const FeatureUnsupported

type Features

+ ContinuousCheckpointing Feature

+ IntegrityData Feature

+ type MaximumChangesSizeExceededError struct

+ type ReadOnlyDatastore interface

+ CheckRevision func(ctx context.Context, revision Revision) error

+ Close func() error

+ Features func(ctx context.Context) (*Features, error)

+ HeadRevision func(ctx context.Context) (Revision, error)

+ OfflineFeatures func() (*Features, error)

+ OptimizedRevision func(ctx context.Context) (Revision, error)

+ ReadyState func(ctx context.Context) (ReadyState, error)

+ RevisionFromString func(serialized string) (Revision, error)

+ SnapshotReader func(Revision) Reader

+ Statistics func(ctx context.Context) (Stats, error)

+ Watch func(ctx context.Context, afterRevision Revision, options WatchOptions) (<-chan *RevisionChanges, <-chan error)

type RevisionChanges

+ Metadata *structpb.Struct

type SchemaDefinition

+ SizeVT func() int

+ type StrictReadDatastore interface

+ IsStrictReadModeEnabled func() bool

type WatchOptions

+ MaximumBufferedChangesByteSize uint64

+ WatchConnectTimeout time.Duration

v0.0.2

Jun 3, 2024

Changes in this version

+ const AWSIAMCredentialProvider

+ const Ellipsis

+ const FilterMaximumIDCount

+ var BuilderForCredentialProvider = map[string]credentialsProviderBuilderFunc

+ var Engines []string

+ var ErrClosedIterator = errors.New("unable to iterate: iterator closed")

+ var ErrCursorEmpty = errors.New("cursors are only available after the first result")

+ var ErrCursorsWithoutSorting = errors.New("cursors are disabled on unsorted results")

+ func CoreFilterFromRelationshipFilter(filter *v1.RelationshipFilter) *core.RelationshipFilter

+ func CredentialsProviderOptions() string

+ func DefinitionsOf[T SchemaDefinition](revisionedDefinitions []RevisionedDefinition[T]) []T

+ func EngineOptions() string

+ func NewCaveatNameNotFoundErr(name string) error

+ func NewCounterAlreadyRegisteredErr(counterName string, filter *core.RelationshipFilter) error

+ func NewCounterNotRegisteredErr(counterName string) error

+ func NewInvalidRevisionErr(revision Revision, reason InvalidRevisionReason) error

+ func NewNamespaceNotFoundErr(nsName string) error

+ func NewReadonlyErr() error

+ func NewWatchCanceledErr() error

+ func NewWatchDisabledErr(reason string) error

+ func NewWatchDisconnectedErr() error

+ func NewWatchTemporaryErr(wrapped error) error

+ func SortedEngineIDs() []string

+ func UnwrapAs[T any](datastore Datastore) T

+ type BulkWriteRelationshipSource interface

+ Next func(ctx context.Context) (*core.RelationTuple, error)

+ type CaveatReader interface

+ ListAllCaveats func(ctx context.Context) ([]RevisionedCaveat, error)

+ LookupCaveatsWithNames func(ctx context.Context, names []string) ([]RevisionedCaveat, error)

+ ReadCaveatByName func(ctx context.Context, name string) (caveat *core.CaveatDefinition, lastWritten Revision, err error)

+ type CaveatStorer interface

+ DeleteCaveats func(ctx context.Context, names []string) error

+ WriteCaveats func(context.Context, []*core.CaveatDefinition) error

+ type CounterReader interface

+ CountRelationships func(ctx context.Context, name string) (int, error)

+ LookupCounters func(ctx context.Context) ([]RelationshipCounter, error)

+ type CounterRegisterer interface

+ RegisterCounter func(ctx context.Context, name string, filter *core.RelationshipFilter) error

+ StoreCounterValue func(ctx context.Context, name string, value int, computedAtRevision Revision) error

+ UnregisterCounter func(ctx context.Context, name string) error

+ type CredentialsProvider interface

+ Get func(ctx context.Context, dbEndpoint string, dbUser string) (string, string, error)

+ IsCleartextToken func() bool

+ Name func() string

+ var NoCredentialsProvider CredentialsProvider = nil

+ func NewCredentialsProvider(ctx context.Context, name string) (CredentialsProvider, error)

+ type Datastore interface

+ CheckRevision func(ctx context.Context, revision Revision) error

+ Close func() error

+ Features func(ctx context.Context) (*Features, error)

+ HeadRevision func(ctx context.Context) (Revision, error)

+ OptimizedRevision func(ctx context.Context) (Revision, error)

+ ReadWriteTx func(context.Context, TxUserFunc, ...options.RWTOptionsOption) (Revision, error)

+ ReadyState func(ctx context.Context) (ReadyState, error)

+ RevisionFromString func(serialized string) (Revision, error)

+ SnapshotReader func(Revision) Reader

+ Statistics func(ctx context.Context) (Stats, error)

+ Watch func(ctx context.Context, afterRevision Revision, options WatchOptions) (<-chan *RevisionChanges, <-chan error)

+ type ErrCaveatNameNotFound struct

+ func (err ErrCaveatNameNotFound) CaveatName() string

+ func (err ErrCaveatNameNotFound) DetailsMetadata() map[string]string

+ func (err ErrCaveatNameNotFound) IsNotFoundError() bool

+ type ErrCounterAlreadyRegistered struct

+ func (err ErrCounterAlreadyRegistered) DetailsMetadata() map[string]string

+ type ErrCounterNotRegistered struct

+ func (err ErrCounterNotRegistered) DetailsMetadata() map[string]string

+ type ErrInvalidRevision struct

+ func (err ErrInvalidRevision) InvalidRevision() Revision

+ func (err ErrInvalidRevision) MarshalZerologObject(e *zerolog.Event)

+ func (err ErrInvalidRevision) Reason() InvalidRevisionReason

+ type ErrNamespaceNotFound struct

+ func (err ErrNamespaceNotFound) DetailsMetadata() map[string]string

+ func (err ErrNamespaceNotFound) IsNotFoundError() bool

+ func (err ErrNamespaceNotFound) MarshalZerologObject(e *zerolog.Event)

+ func (err ErrNamespaceNotFound) NotFoundNamespaceName() string

+ type ErrNotFound interface

+ IsNotFoundError func() bool

+ type ErrReadOnly struct

+ type ErrWatchCanceled struct

+ type ErrWatchDisabled struct

+ type ErrWatchDisconnected struct

+ type ErrWatchRetryable struct

+ type Feature struct

+ Enabled bool

+ Reason string

+ type Features struct

+ Watch Feature

+ type InvalidRevisionReason int

+ const CouldNotDetermineRevision

+ const RevisionStale

+ type ObjectTypeStat struct

+ NumPermissions uint32

+ NumRelations uint32

+ func ComputeObjectTypeStats(objTypes []RevisionedNamespace) []ObjectTypeStat

+ type ReadWriteTransaction interface

+ BulkLoad func(ctx context.Context, iter BulkWriteRelationshipSource) (uint64, error)

+ DeleteNamespaces func(ctx context.Context, nsNames ...string) error

+ DeleteRelationships func(ctx context.Context, filter *v1.RelationshipFilter, ...) (bool, error)

+ WriteNamespaces func(ctx context.Context, newConfigs ...*core.NamespaceDefinition) error

+ WriteRelationships func(ctx context.Context, mutations []*core.RelationTupleUpdate) error

+ type Reader interface

+ ListAllNamespaces func(ctx context.Context) ([]RevisionedNamespace, error)

+ LookupNamespacesWithNames func(ctx context.Context, nsNames []string) ([]RevisionedNamespace, error)

+ QueryRelationships func(ctx context.Context, filter RelationshipsFilter, ...) (RelationshipIterator, error)

+ ReadNamespaceByName func(ctx context.Context, nsName string) (ns *core.NamespaceDefinition, lastWritten Revision, err error)

+ ReverseQueryRelationships func(ctx context.Context, subjectsFilter SubjectsFilter, ...) (RelationshipIterator, error)

+ type ReadyState struct

+ IsReady bool

+ Message string

+ type RelationshipCounter struct

+ ComputedAtRevision Revision

+ Count int

+ Filter *core.RelationshipFilter

+ Name string

+ type RelationshipIterator interface

+ Close func()

+ Cursor func() (options.Cursor, error)

+ Err func() error

+ Next func() *core.RelationTuple

+ type RelationshipQueryOperation int

+ const RelationshipQueryAnd

+ const RelationshipQueryNone

+ const RelationshipQueryOr

+ type RelationshipsFilter struct

+ OptionalCaveatName string

+ OptionalResourceIDPrefix string

+ OptionalResourceIds []string

+ OptionalResourceRelation string

+ OptionalResourceType string

+ OptionalSubjectsSelectors []SubjectsSelector

+ func RelationshipsFilterFromCoreFilter(filter *core.RelationshipFilter) (RelationshipsFilter, error)

+ func RelationshipsFilterFromPublicFilter(filter *v1.RelationshipFilter) (RelationshipsFilter, error)

+ func (rf RelationshipsFilter) Test(relationship *core.RelationTuple) bool

+ type RelationshipsQueryTree struct

+ func NewRelationshipQueryTree(filter RelationshipsFilter) RelationshipsQueryTree

+ type RepairOperation struct

+ Description string

+ Name string

+ type RepairableDatastore interface

+ Repair func(ctx context.Context, operationName string, outputProgress bool) error

+ RepairOperations func() []RepairOperation

+ type Revision interface

+ Equal func(Revision) bool

+ GreaterThan func(Revision) bool

+ LessThan func(Revision) bool

+ var NoRevision Revision = nilRevision{}

+ type RevisionChanges struct

+ ChangedDefinitions []SchemaDefinition

+ DeletedCaveats []string

+ DeletedNamespaces []string

+ IsCheckpoint bool

+ RelationshipChanges []*core.RelationTupleUpdate

+ Revision Revision

+ func (rc *RevisionChanges) MarshalZerologObject(e *zerolog.Event)

+ type RevisionedCaveat = RevisionedDefinition[*core.CaveatDefinition]

+ type RevisionedDefinition struct

+ Definition T

+ LastWrittenRevision Revision

+ func (rd RevisionedDefinition[T]) GetLastWrittenRevision() Revision

+ type RevisionedNamespace = RevisionedDefinition[*core.NamespaceDefinition]

+ type SchemaDefinition interface

+ GetName func() string

+ type StartableDatastore interface

+ Start func(ctx context.Context) error

+ type Stats struct

+ EstimatedRelationshipCount uint64

+ ObjectTypeStatistics []ObjectTypeStat

+ UniqueID string

+ type SubjectRelationFilter struct

+ IncludeEllipsisRelation bool

+ NonEllipsisRelation string

+ OnlyNonEllipsisRelations bool

+ func (sf SubjectRelationFilter) IsEmpty() bool

+ func (sf SubjectRelationFilter) WithEllipsisRelation() SubjectRelationFilter

+ func (sf SubjectRelationFilter) WithNonEllipsisRelation(relation string) SubjectRelationFilter

+ func (sf SubjectRelationFilter) WithOnlyNonEllipsisRelations() SubjectRelationFilter

+ func (sf SubjectRelationFilter) WithRelation(relation string) SubjectRelationFilter

+ type SubjectsFilter struct

+ OptionalSubjectIds []string

+ RelationFilter SubjectRelationFilter

+ SubjectType string

+ func (sf SubjectsFilter) AsSelector() SubjectsSelector

+ type SubjectsSelector struct

+ OptionalSubjectIds []string

+ OptionalSubjectType string

+ RelationFilter SubjectRelationFilter

+ func (ss SubjectsSelector) Test(subject *core.ObjectAndRelation) bool

+ type TxUserFunc func(context.Context, ReadWriteTransaction) error

+ type UnwrappableDatastore interface

+ Unwrap func() Datastore

+ type WatchContent int

+ const WatchCheckpoints

+ const WatchRelationships

+ const WatchSchema

+ type WatchOptions struct

+ CheckpointInterval time.Duration

+ Content WatchContent

+ WatchBufferLength uint16

+ WatchBufferWriteTimeout time.Duration

+ func WatchJustRelationships() WatchOptions

+ func WatchJustSchema() WatchOptions

+ func (wo WatchOptions) WithCheckpointInterval(interval time.Duration) WatchOptions

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