JoinQueryBuilder class

Implemented types

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sortOrders → Iterable<FieldSort>
no setter

Methods

addCompositeCondition(Iterable<SimpleCondition> conditions) → SnapshotEmitterInternal<Map<String, DocumentReference?>>
clone() → SnapshotEmitterInternal<Map<String, DocumentReference?>>
dereference() → DereferencedJoin
Dereferences the document references in the result of this query. For example, collection.query().snapshot() returns an array of DocumentReference objects, but collection.query().dereference().snapshot() returns an array of the actual document data.
eq(FieldName fieldName, dynamic value) → JoinQueryBuilder
A shortcut for where with Operator.equals.
inherited
extractData(Map<String, DocumentReference?> data) → dynamic
flipSortOrder() → SnapshotEmitterInternal<Map<String, DocumentReference?>>
getLimit() → int
grouped() → GroupedJoin
Transforms this join query result to a nested data structure. For example, a join between teachers and students normally returns a result of the form: { teacher: {name: 'Mr. Smith'}, student: {name: 'John Doe'} }, { teacher: {name: 'Mr. Smith'}, student: {name: 'Jane Smith'} }, { teacher: {name: 'Mr. EmptyClass'}, student: undefined }, into a result of the form: [ { teacher: {name: 'Mr. Smith'}, students: { name: 'John Doe' }, { name: 'Jane Smith' }, }, { teacher: {name: 'Mr. EmptyClass'}, students: [] }, ]
gt(FieldName fieldName, dynamic value) → JoinQueryBuilder
A shortcut for where with Operator.greaterThan.
inherited
gte(FieldName fieldName, dynamic value) → JoinQueryBuilder
A shortcut for where with Operator.greaterThanOrEqual.
inherited
isIn(FieldName fieldName, Iterable values) → JoinQueryBuilder
A shortcut for where with Operator.inList.
inherited
isNotIn(FieldName fieldName, Iterable values) → JoinQueryBuilder
A shortcut for where with Operator.notInList.
inherited
join(QueryBuilder queryBuilder, {required Alias alias, required (FieldName, FieldName) joinFields, Alias? leftAlias, dynamic isInner = false}) → JoinQueryBuilder
like(FieldName fieldName, String value, {bool caseSensitive = true}) → JoinQueryBuilder
A shortcut for where with Operator.like (case insensitive) or Operator.likeCs (case sensitive).
inherited
limit(int limit) → JoinQueryBuilder
Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000 if none is provided.
limitBy(int limit, {Iterable<FieldName> fields = const []}) → JoinQueryBuilder
lt(FieldName fieldName, dynamic value) → JoinQueryBuilder
A shortcut for where with Operator.lessThan.
inherited
lte(FieldName fieldName, dynamic value) → JoinQueryBuilder
A shortcut for where with Operator.lessThanOrEqual.
inherited
neq(FieldName fieldName, dynamic value) → JoinQueryBuilder
A shortcut for where with Operator.notEquals.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notLike(FieldName fieldName, String value, {bool caseSensitive = true}) → JoinQueryBuilder
A shortcut for where with Operator.notLike (case insensitive) or Operator.notLikeCs (case sensitive).
inherited
paginate({int pageSize = 100, bool subscribe = true}) → Pagination<Map<String, DocumentReference?>>
Returns a pagination wrapper for this query with pageSize defaulting to 100 and subscribe defaulting to true.
inherited
peek() → Iterable<Map<String, DocumentReference?>>
inherited
snapshot() → Future<Iterable<Map<String, DocumentReference?>>>
Returns a promise that resolves to the query results.
inherited
snapshots({bool subscribe = true}) → Observable<Iterable<Map<String, DocumentReference?>>>
Returns an observable that emits the query results and updates whenever the query results change unless subscribe=false is provided.
override
sortBy(FieldName fieldName, [SortOrder order = SortOrder.asc]) → JoinQueryBuilder
Adds a sort order to the query. You can add multiple sort orders to the query. The order in which you add them determines the order in which they are applied. If no sort order is provided, SortOrder.asc is used.
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited
where(FieldName fieldName, Operator operator, dynamic value) → JoinQueryBuilder
Adds a condition to the query.

Operators

operator ==(Object other) → bool
The equality operator.
inherited