Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
isar
→ Isar
-
The corresponding Isar instance.
no setter
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
buildQuery<R>({List<WhereClause> whereClauses = const [], bool whereDistinct = false, Sort whereSort = Sort.asc, FilterGroup? filter, List<SortProperty> sortBy = const [], List<DistinctProperty> distinctBy = const [], int? offset, int? limit, String? property})
→ Query<R>
-
Build a query dynamically. Can be used to build a custom query language.
-
delete(int id)
→ Future<bool>
-
Delete a single object by its
id
. Returns whether the object has been
deleted.
-
deleteAll(List<int> ids)
→ Future<int>
-
Delete a list of objecs by their
ids
. Returns the number of objects that
have been deleted.
-
deleteAllByIndex(String indexName, List<List> values)
→ Future<int>
-
Delete a list of objecs by the
indexName
index. Returns the number
of objects that have been deleted. Don't use this method directly.
-
deleteAllByIndexSync(String indexName, List<List> values)
→ int
-
Delete a list of objecs by the
indexName
index. Returns the number
of objects that have been deleted. Don't use this method directly.
-
deleteAllSync(List<int> ids)
→ int
-
Delete a list of objecs by their
ids
. Returns the number of objects that
have been deleted.
-
deleteSync(int id)
→ bool
-
Delete a single object by its
id
. Returns whether the object has been
deleted.
-
get(int id)
→ Future<OBJ?>
-
Get a single object by its
id
or null
if the object does not exist.
-
getAll(List<int> ids)
→ Future<List<OBJ?>>
-
Get a list of objects by their
ids
or null
if an object does not
exist.
-
getAllByIndex(String indexName, List<List> values)
→ Future<List<OBJ?>>
-
Get a list of objects by the
indexName
index or null
if an object
does not exist. Don't use this method directly.
-
getAllByIndexSync(String indexName, List<List> values)
→ List<OBJ?>
-
Get a list of objects by the
indexName
index or null
if an object
does not exist. Don't use this method directly.
-
getAllSync(List<int> ids)
→ List<OBJ?>
-
Get a list of objects by their
ids
or null
if an object does not
exist.
-
getSync(int id)
→ OBJ?
-
Get a single object by
its
id or null
if the object does not exist.
-
importJson(List<Map<String, dynamic>> json, {bool replaceOnConflict = false})
→ Future<void>
-
Import a list of json objects.
-
importJsonRaw(Uint8List jsonBytes, {bool replaceOnConflict = false})
→ Future<void>
-
Import a list of json objects.
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
put(OBJ object, {bool replaceOnConflict = false})
→ Future<int>
-
Insert or update an
object
and returns the assigned id.
-
putAll(List<OBJ> objects, {bool replaceOnConflict = false})
→ Future<List<int>>
-
Insert or update a list of
objects
and returns the list of assigned ids.
-
putAllSync(List<OBJ> objects, {bool replaceOnConflict = false})
→ List<int>
-
Insert or update a list of
objects
and returns the list of assigned ids.
-
putSync(OBJ object, {bool replaceOnConflict = false})
→ int
-
Insert or update an
object
and returns the assigned id.
-
toString()
→ String
-
A string representation of this object.
inherited
-
watchLazy()
→ Stream<void>
-
Watch the collection for changes.
-
watchObject(int id, {bool initialReturn = false})
→ Stream<OBJ?>
-
Watch an object with
id
for changes.
-
watchObjectLazy(int id)
→ Stream<void>
-
Watch an object with
id
for changes.
-
where({bool distinct = false, Sort sort = Sort.asc})
→ QueryBuilder<OBJ, OBJ, QWhere>
-
Start building a query using the QueryBuilder.