objectbox library

ObjectBox for Dart is a standalone database storing Dart objects locally, with strong ACID semantics.

See the README to get started.

Classes

Box<T>
A box to store objects of a particular class.
Condition
ConditionGroup
ConditionGroupAll
ConditionGroupAny
DoubleCondition
DoublePropertyQuery
Entity
EntityDefinition<T>
Used by the generated code as a container for model loading callables
Id
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. It is serialized as two numerical values concatenated using a colon (:). See the documentation for more information on [...]
IntegerCondition
IntegerPropertyQuery
Model
ModelDefinition
ModelEntity
ModelEntity describes an entity of a model and consists of instances of ModelProperty as well as an other entity information: id, name and last property id.
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; eventually, ObjectBox Dart models will be fully compatible to them. This is also why for explanations on most concepts related to ObjectBox models, you can refer to the existing documentation.
ModelProperty
ModelProperty describes a single property of an entity, i.e. its id, name, type and flags.
Order
Property
A dart int value can map to different OBXPropertyTypes, e.g. Short (Int16), Int (Int32), Long (Int64), all signed values. Also a dart double can also map to e.g. Float and Double [...]
PropertyCondition<DartType>
PropertyQuery<T>
Query<T>
A repeatable Query returning the latest matching Objects. [...]
QueryBooleanProperty
QueryBuilder<T>
QueryDoubleProperty
QueryIntegerProperty
QueryProperty
The QueryProperty types are responsible for the operator overloading. A QueryBuilder will be constructed, based on the any / all operations applied. When build() is called on the QueryBuilder a Query object will be created.
QueryStringProperty
Store
Represents an ObjectBox database and works together with Box to allow getting and putting Objects of specific type.
StringCondition
StringPropertyQuery
Transient
Version

Functions

versionLib() Version
Returns the underlying ObjectBox-C library version

Enums

ConditionOp
TxMode

Typedefs

ObjectReader<T>(T object) → Map<String, dynamic>
ObjectWriter<T>(Map<String, dynamic> properties) → T

Exceptions / Errors

ObjectBoxException