entify library

Classes

ApiRepresentation<T>
Every class in entify that can be represented with a package:googleapis object implement this interface.
CompoundFilter
A compound filter has a list of filter predicates. [...]
DatastoreShell
Provides a useful interface over the package:googleapis DatastoreApi object.
Entity
Represents a Datastore entity. Allows a simpler, easier to manage interface than the API class (in package:googleapis). [...]
EntityBridge<T>
Maps entity model objects of a certain type to Entity objects and back. [...]
EntityModel
Marks the class as a persistent object, mappable to entities.
EntityVersion
Fields with type of int and marked with this annotation will be set to the entity version, or null if the entity version info is missing (for example all reads without strong consistency).
Filter
Every class that can be used as a filter implements this interface.
FilterOperator
FilterPredicate
Every class that can be used as a filter predicate implements this interface.
IndexedOverride<T>
Key
An immutable class that represents a Datastore key.
MutationBatch
Represents a set of mutations that can be submitted with a commit call (either transactionally or nontransactionally).
MutationBatchResponse
The result of a mutation is an array of keys which are set to either the generated keys or to null if no key generation was necessary.
Persistent
Marks the field as persistent, mappable to entity properties.
PreparedQuery
Contains methods for fetching and returning entities from a Query.
Projection
Represents a projection that can be added to a query.
PropertyFilterPredicate
Filters on a single property.
PropertyOutlet
A helper class to add indexed/unindexed properties to Entity objects using the [] operator. [...]
PropertySort
Specifies a sorting order to use to return the entities in a query.
Query
A query for entities.
QueryResult<T>
QueryResultBatch
A bunch of entities returned from a query.
ReadConsistency
Specifies read consistency.
SortDirection
Specifies a sorting direction.

Constants

entityModel → const EntityModel
Attribute for entity model classes with the default kind name (the class name).
const EntityModel()
entityVersion → const EntityVersion
Fields with type of int and marked with this annotation will be set to the entity version, or null if the entity version info is missing (for example all reads without strong consistency).
const EntityVersion()
persistent → const Persistent
Persistent with default settings. [...]
const Persistent()
primaryKey → const Persistent
The field is the primary key.
const Persistent(primaryKey: true)
unindexed → const Persistent
Same as persistent except that this property value will be unindexed.
const Persistent(indexed: false)

Functions

fromValue(Value value) Object
Converts an API value to a Dart object. [...]
toValue(Object obj, {bool excludeFromIndexes}) Value
Converts an arbitrary object to an API value. [...]

Typedefs

CommitCallback = void Function(MutationBatch batch)
ModelFactory<T> = T Function()

Exceptions / Errors

DatastoreConflictError
DatastoreShellError
Thrown when there's an underlying issue with the Datastore.
DatastoreTransientError
EntityModelError
Thrown when there was an error during entity model metadata extraction or during entity property mapping.
EntityNotFoundError
Thrown when a single entity query failed.
UnknownDatastoreError
WrappedServerError