isar library

Classes

Annotation to create a backlink to an existing link.
Collection
Annotation to create an Isar collection.
CollectionSchema<OBJ>
This schema represents a collection.
CompactCondition
Isar databases can contain unused space that will be reused for later operations. You can specify conditions to trigger manual compaction where the entire database is copied and unused space freed.
CompositeIndex
Another property that is part of the composite index.
DistinctProperty
Property used to filter duplicate values.
Embedded
Annotation to nest objects of this type in collections.
Enumerated
Annotation to specify how an enum property should be serialized.
FilterCondition
Create a filter condition dynamically.
FilterGroup
Group one or more filter conditions.
IdWhereClause
A where clause traversing the primary index (ids).
Ignore
Annotate a property or accessor in an Isar collection to ignore it.
Index
Annotate properties to build an index.
IndexPropertySchema
This schema represents a composite index property.
IndexSchema
This schema represents an index.
IndexWhereClause
A where clause traversing an index.
Isar
An instance of the Isar Database.
IsarCollection<OBJ>
Use IsarCollection instances to find, query, and create new objects of a given type in Isar.
Establishes a 1:1 relationship with the same or another collection. The target collection is specified by the generic type argument.
Establishes a 1:n relationship with the same or another collection. The target collection is specified by the generic type argument.
LinkFilter
Filter condition based on a link.
LinkSchema
This schema represents a link to the same or another collection.
LinkWhereClause
A where clause traversing objects linked to the specified object.
Name
Annotate Isar collections or properties to change their name.
ObjectFilter
Filter condition based on an embedded object.
PropertySchema
A single propery of a collection or embedded object.
Query<T>
Querying is how you find records that match certain conditions.
QueryBuilder<OBJ, R, S>
Query builders are used to create queries in a safe way.
Schema<OBJ>
This schema either represents a collection or embedded object.
SortProperty
Property used to sort query results.
WhereClause
A where clause to traverse an Isar index.

Enums

EnumType
Enum type for enum values.
FilterConditionType
The type of dynamic filter conditions.
FilterGroupType
The type of filter groups.
IndexType
Specifies how an index is stored in Isar.
IsarType
Supported Isar types
Sort
Sort order

Extensions

QueryAggregation
Extension for Queries
QueryDateAggregation
Extension for Queries
QueryExecute
Extension for QueryBuilders
QueryExecuteAggregation
Extension for QueryBuilders
QueryExecuteDateAggregation
Extension for QueryBuilders
QueryFilterAndOr
Extension for QueryBuilders.
QueryFilterNoGroups
Extension for QueryBuilders.
QueryFilterNot
Extension for QueryBuilders.
QueryFilters
Extension for QueryBuilders.
QueryLimit
Extension for QueryBuilders.
QueryModifier
Extension for QueryBuilders.
QueryOffset
Extension for QueryBuilders.
QueryWhere
Extension for QueryBuilders.
QueryWhereOr
Extension for QueryBuilders.

Constants

collection → const Collection
Annotation to create an Isar collection.
embedded → const Embedded
Annotation to nest objects of this type in collections.
enumerated → const Enumerated
Annotation to specify how an enum property should be serialized.
ignore → const Ignore
Annotate a property or accessor in an Isar collection to ignore it.

Typedefs

byte = int
Type to mark an int property or List as 8-bit sized.
float = double
Type to mark a double property or List to have 32-bit precision.
Id = int
Type to specify the id property of a collection.
IndexKey = List<Object?>
Normal keys consist of a single object, composite keys multiple.
IsarCloseCallback = void Function(String isarName)
Callback for a release Isar instance.
IsarOpenCallback = void Function(Isar isar)
Callback for a newly opened Isar instance.
short = int
Type to mark an int property or List as 32-bit sized.

Exceptions / Errors

IsarError
An error raised by Isar.
IsarUniqueViolationError
This error is returned when a unique index constraint is violated.