# Functions
IterAll returns an iterator instance that loops through all entities kept by given bucket.
No description provided by the author
MarshalVersionedID is used to guarantee determinism while serializing a VersionedIDRef.
NewBucket creates a bucket to store data.
NewCounter returns an initialized counter.
NewModelBucket returns a ModelBucket instance.
NewMultiKeyIndex constructs an index with multi key indexer.
NewMultiRef creates a MultiRef with any number of initial references.
NewNativeIndex returns an index implementation that is using a database native storage and query in order to maintain and provide access to an index.
NewSequence returns a sequence counter.
NewSerialModelBucket returns a SerialModelBucket instance.
NewSimpleObj will combine a key and value into an object.
RegisterQuery will register a root query (literal keys) under "/".
No description provided by the author
UnmarshalVersionedID is used to deserialize a VersionedIDRef from a deterministic format.
ValidateSequence returns an error if this is not an 8-byte as expected for orm.IDGenBucket.
WithIDGenerator creates a bucket with uses the given id generator on top of the given bucket implementation.
WithIDSequence configures the bucket to use the given sequence instance for generating ID.
WithIndex configures the bucket to build an index with given name.
WithIndexSerial configures the bucket to build an index with given name.
WithNativeIndex configures a bucket to maintain an index.
WithSeqIDGenerator adds a Sequence for primary ID key generation on top fo the given bucket implementation.
WithVersioning add versioning functionality to the underlying bucket.
# Constants
SeqID is a constant to use to get a default ID sequence.
# Variables
ErrBucket is returned when already initialized bucket is tried to be indexed again.
No description provided by the author
ErrInvalidIndex is returned when an index specified is invalid.
No description provided by the author
# Structs
Counter could be used for sequence, but mainly just for test.
CounterWithID could be used for sequence, but mainly just for test.
No description provided by the author
ModelBucketIterator allows for iteration over all entities of a single bucket.
MultiRef contains a list of references to pks.
Sequence maintains a counter, and generates a series of keys.
SimpleObj wraps a key and a value together It can be used as a template for type-safe objects.
VersionedID is the combination of document ID and version number.
No description provided by the author
# Interfaces
No description provided by the author
CloneableData is an intelligent Value that can be embedded in a simple object to handle much of the details.
IDGenerator defines an interface for custom id generators.
No description provided by the author
Model is implemented by any entity that can be stored using ModelBucket.
ModelBucket is implemented by buckets that operates on Models rather than Objects.
ModelSlicePtr represents a pointer to a slice of models.
Object is what is stored in the bucket Key is joined with the prefix to set the full key Value is the data stored
this can be light wrapper around a protobuf-defined type.
SerialModel is implemented by any entity that can be stored using SerialModelBucket.
SerialModelBucket is implemented by buckets that operates on SerialModels rather than Objects.
SerialModelIterator over a domain of keys in ascending order.
SerialModelSlicePtr represents a pointer to a slice of SerialModels.
# Type aliases
IDGeneratorFunc provides IDGenerator interface support.
Indexer calculates the secondary index key for a given object.
ModelBucketOption is implemented by any function that can configure ModelBucket during creation.
MultiKeyIndexer calculates the secondary index keys for a given object.
SerialModelBucketOption is implemented by any function that can configure SerialModelBucket during creation.