internal library

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

Classes

BacklinkSource
Contains either a source property (backlink from to-one) or a source relation (backlink from to-many).
BacklinkSourceProperty
BacklinkSourceRelation
EntityDefinition<T>
Used by the generated code as a container for model loading callables
Float32ListReader
Reads a list of 32-bit floating points as a Float32List.
Float64ListReader
Reads a list of 64-bit floating points as a Float64List.
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.
Int16ListReader
Reads a list of signed 16-bit integers as a Int16List.
Int32ListReader
Reads a list of signed 32-bit integers as a Int32List.
Int64ListReader
Reads a list of signed 64-bit integers as a Int64List.
InternalStoreAccess
Internal only.
InternalToManyAccess
Internal only.
InternalToManyTestAccess<EntityT>
Internal only.
ModelBacklink describes a relation backlink
ModelDefinition
ModelEntity
ModelEntity describes an entity of a model.
ModelHnswParams
Describes HNSW index parameters for a float vector property.
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
OBXHnswFlags
Bit-flags to influence the behavior of HNSW index (vector search).
OBXPropertyFlags
Bit-flags defining the behavior of properties. Note: Numbers indicate the bit position
OBXPropertyType
OBXVectorDistanceType
The vector distance algorithm used by an HNSW index (vector search).
RelInfo<SourceEntityT>
Holds relation information for a field.
Uint16ListReader
Reads a list of unsigned 16-bit integers as a Uint16List.
Uint32ListReader
Reads a list of unsigned 32-bit integers as a Uint32List.
Uint64ListReader
Reads a list of unsigned 64-bit integers as a Uint64List.

Enums

RelType
Specifies a type of a relation field.

Extensions

ModelHnswFlags on HnswFlags
Adds mapping to internal flags.
ModelVectorDistanceType on VectorDistanceType
Adds mapping to internal constants.

Functions

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