# Packages
Code generated by github.com/ecordell/optgen.
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
ComputeObjectTypeStats creates a list of object type stats from an input list of parsed object types.
CoreFilterFromRelationshipFilter constructs a core RelationshipFilter from a V1 RelationshipsFilter.
CredentialsProviderOptions returns the full set of credential provider names, sorted and quoted into a string.
DefinitionsOf returns just the schema definitions found in the list of revisioned definitions.
DeleteAllData deletes all data from the datastore.
EngineOptions returns the full set of engine IDs, sorted and quoted into a string.
FirstRelationshipIn returns the first relationship found via the iterator, if any.
No description provided by the author
NewCaveatNameNotFoundErr constructs a new caveat name not found error.
NewCounterAlreadyRegisteredErr constructs a new filter not registered error.
NewCounterNotRegisteredErr constructs a new counter not registered error.
NewCredentialsProvider create a new CredentialsProvider for the given name returns an error if no match is found, of if there is a problem creating the given CredentialsProvider.
NewInvalidRevisionErr constructs a new invalid revision error.
NewMaximumChangesSizeExceededError creates a new MaximumChangesSizeExceededError.
NewNamespaceNotFoundErr constructs a new namespace not found error.
NewReadonlyErr constructs an error for when a request has failed because the datastore has been configured to be read-only.
No description provided by the author
NewWatchCanceledErr constructs a new watch was canceled error.
NewWatchDisabledErr constructs a new watch is disabled error.
NewWatchDisconnectedErr constructs a new watch was disconnected error.
NewWatchTemporaryErr wraps another error in watch, indicating that the error is likely a temporary condition and clients may consider retrying by calling watch again (vs a fatal error).
RelationshipsFilterFromCoreFilter constructs a datastore RelationshipsFilter from a core RelationshipFilter.
RelationshipsFilterFromPublicFilter constructs a datastore RelationshipsFilter from an API-defined RelationshipFilter.
SortedEngineIDs returns the full set of engine IDs, sorted.
UnwrapAs recursively attempts to unwrap the datastore into the specified type In none of the layers of the datastore implement the specified type, nil is returned.
WatchJustRelationships returns watch options for just relationships.
WatchJustSchema returns watch options for just schema.
# Constants
AWSIAMCredentialProvider generates AWS IAM tokens for authenticating with the datastore (i.e.
CouldNotDetermineRevision is the reason returned when a revision for a request could not be determined.
Ellipsis is a special relation that is assumed to be valid on the right hand side of a tuple.
EmitImmediatelyStrategy emits changes as soon as they are available.
EmitWhenCheckpointedStrategy will buffer changes until a checkpoint is reached.
ExpirationFilterOptionHasExpiration indicates that the expiration filter should only return relationships with an expiration.
ExpirationFilterOptionNoExpiration indicates that the expiration filter should only return relationships without an expiration.
ExpirationFilterOptionNone indicates that the expiration filter should not be used: relationships both with and without expiration will be returned.
FeatureStatusUnknown indicates that the status of the feature is unknown.
FeatureSupported indicates that the feature is supported by the datastore.
FeatureUnsupported indicates that the feature is not supported by the datastore.
No description provided by the author
No description provided by the author
No description provided by the author
RevisionStale is the reason returned when a revision is outside the window of validity by being too old.
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NoRevision is a zero type for the revision that will make changing the revision type in the future a bit easier if necessary.
# Structs
CaveatNameNotFoundError is the error returned when a caveat is not found by its name.
CounterAlreadyRegisteredError indicates that a counter was already registered.
CounterNotRegisteredError indicates that a counter was not registered.
Feature represents a capability that a datastore can support, plus an optional message explaining the feature is available (or not).
Features holds values that represent what features a database can support.
InvalidRevisionError occurs when a revision specified to a call was invalid.
MaximumChangesSizeExceededError is returned when the maximum size of changes is exceeded.
NamespaceNotFoundError occurs when a namespace was not found.
ObjectTypeStat represents statistics for a single object type (namespace).
ReadOnlyError is returned when the operation cannot be completed because the datastore is in read-only mode.
ReadyState represents the ready state of the datastore.
RelationshipCounter is a struct that represents a count of relationships that match a filter.
RelationshipsFilter is a filter for relationships.
No description provided by the author
RepairOperation represents a single kind of repair operation that can be run in a repairable datastore.
RevisionChanges represents the changes in a single transaction.
RevisionedDefinition holds a schema definition and its last updated revision.
Stats represents statistics for the entire datastore.
SubjectRelationFilter is the filter to use for relation(s) of subjects being queried.
SubjectsFilter is a filter for subjects.
SubjectsSelector is a selector for subjects.
WatchCanceledError occurs when a watch was canceled by the caller.
WatchDisabledError occurs when watch is disabled by being unsupported by the datastore.
WatchDisconnectedError occurs when a watch has fallen too far behind and was forcibly disconnected as a result.
WatchOptions are options for a Watch call.
WatchRetryableError is returned when a transient/temporary error occurred in watch and indicates that the caller *may* retry the watch after some backoff time.
# Interfaces
BulkWriteRelationshipSource is an interface for transferring relationships to a backing datastore with a zero-copy methodology.
CaveatReader offers read operations for caveats.
CaveatStorer offers both read and write operations for Caveats.
CounterReader is an interface for reading counts.
CounterRegisterer is an interface for registering and unregistering counts.
CredentialsProvider allows datastore credentials to be retrieved dynamically.
Datastore represents tuple access for a single namespace.
ErrNotFound is a shared interface for not found errors.
Reader is an interface for reading relationships from the datastore.
ReadOnlyDatastore is an interface for reading relationships from the datastore.
No description provided by the author
RepairableDatastore is an optional extension to the datastore interface that, when implemented, provides the ability for callers to repair the datastore's data in some fashion.
Revision is an interface for a comparable revision type that can be different for each datastore implementation.
SchemaDefinition represents a namespace or caveat definition under a schema.
StartableDatastore is an optional extension to the datastore interface that, when implemented, provides the ability for callers to start background operations on the datastore.
StrictReadDatastore is an interface for datastores that support strict read mode.
UnwrappableDatastore represents a datastore that can be unwrapped into the underlying datastore.
# Type aliases
EmissionStrategy describes when changes are emitted to the client.
ExpirationFilterOption is the filter option for the expiration field on relationships.
FeatureStatus are the possible statuses for a feature in the datastore.
InvalidRevisionReason is the reason the revision could not be used.
No description provided by the author
TxUserFunc is a type for the function that users supply when they invoke a read-write transaction.
No description provided by the author