objectbox_internal library Null safety

This library serves as an entrypoint for generated code and objectbox tools. Don't import into your own code, use 'objectbox.dart' instead.

Classes

EagerListReader<E>
Implements eager FlatBuffers list reader (default ListReader is lazy).
EntityDefinition<T>
Used by the generated code as a container for model loading callables
IdUid
IdUid represents a compound of an ID, which is locally unique, i.e. inside an entity, and a UID, which is globally unique, i.e. for the entire model. [...]
InternalSyncTestAccess
Tests only.
InternalToManyAccess
Internal only.
InternalToManyTestAccess<EntityT>
Internal only.
InternalToOneAccess
Internal only.
Model
ModelBacklink describes a relation backlink
ModelDefinition
ModelEntity
ModelEntity describes an entity of a model.
ModelInfo
In order to represent the model stored in objectbox-model.json in Dart, several classes have been introduced. Conceptually, these classes are comparable to how models are handled in ObjectBox Java and ObjectBox Go. This is also why for explanations on most concepts related to ObjectBox models, you can refer to https://docs.objectbox.io/advanced.
ModelProperty
ModelProperty describes a single property of an entity.
ModelRelation
ModelRelation describes a standalone relation
OBXEntityFlags
/// Bit-flags defining the behavior of entities. /// Note: Numbers indicate the bit position
OBXPropertyFlags
/// Bit-flags defining the behavior of properties. /// Note: Numbers indicate the bit position
OBXPropertyType
QueryBooleanProperty<EntityT>
QueryByteVectorProperty<EntityT>
QueryDoubleProperty<EntityT>
QueryIntegerProperty<EntityT>
QueryParam<DartType>
QueryParam
QueryProperty<EntityT, DartType>
The QueryProperty types allow users to build query conditions on a property.
QueryRelationToMany<Source, Target>
QueryRelationToOne<Source, Target>
QueryStringProperty<EntityT>
QueryStringVectorProperty<EntityT>
RelInfo<SourceEntityT>
Holds relation information for a field.

Extensions

QueryParamBool
QueryParam for boolean properties
QueryParamBytes
QueryParam for byte vector properties
QueryParamDouble
QueryParam for double properties
QueryParamInt
QueryParam for int properties
QueryParamString
QueryParam for string properties
QuerySetParam
Adds capabilities to set query parameters

Functions

obxPropertyTypeToString(int type) String
Maps OBXPropertyType to its string representation (name).
propertyTypeToOBXPropertyType(PropertyType type) int

Enums

RelType
Specifies a type of a relation field.