CollectionGroup extension type
A CollectionGroup
refers to all documents that are contained in a
collection or subcollection with a specific collection ID.
- on
- Implemented types
- Available extensions
Properties
Methods
-
aggregate(
JSObject aggregateSpec) → AggregateQuery -
Returns a query that can perform the given aggregations.
inherited
-
count(
) → AggregateQuery -
Returns a query that counts the documents in the result set of this
query.
inherited
-
endAt(
DocumentSnapshot snapshot) → Query -
Creates and returns a new Query that ends before the provided fields
relative to the order of the query. The order of the field values
must match the order of the order by clauses of the query.
inherited
-
endBefore(
DocumentSnapshot snapshot) → Query -
Creates and returns a new Query that starts after the provided fields
relative to the order of the query. The order of the field values
must match the order of the order by clauses of the query.
inherited
-
explain(
ExplainOptions options) → JSPromise< ExplainResults< QuerySnapshot> > -
Plans and optionally executes this query. Returns a Promise that will be
resolved with the planner information, statistics from the query execution (if any),
and the query results (if any).
inherited
-
findNearest(
JSAny vectorField, JSObject queryVector, JSObject options) → VectorQuery -
Returns a query that can perform vector distance (similarity) search with given parameters.
inherited
-
get(
) → JSPromise< QuerySnapshot> -
Creates and returns a new Query that ends at the provided fields
relative to the order of the query. The order of the field values
must match the order of the order by clauses of the query.
inherited
-
isEqual(
Query other) → bool -
Returns true if this
Query
is equal to the provided one.inherited -
limit(
int limit) → Query -
Creates and returns a new Query that only returns the first matching
documents.
inherited
-
limitToLast(
int limit) → Query -
Creates and returns a new Query that only returns the last matching
documents.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
offset(
int offset) → Query -
Specifies the offset of the returned results.
inherited
-
onSnapshot(
JSFunction onNext, [JSFunction onError]) → void -
Executes the query and returns the results as Node Stream.
inherited
-
orderBy(
JSAny fieldPath, [String directionStr]) → Query -
Creates and returns a new Query that's additionally sorted by the
specified field, optionally in descending order instead of ascending.
inherited
-
startAfter(
DocumentSnapshot snapshot) → Query -
Creates and returns a new Query that starts at the provided fields
relative to the order of the query. The order of the field values
must match the order of the order by clauses of the query.
inherited
-
startAt(
DocumentSnapshot snapshot) → Query -
Creates and returns a new Query instance that applies a field mask to
the result and returns only the specified subset of fields. You can
specify a list of field paths to return, or use an empty list to only
return the references of matching documents.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
where(
Filter filter) → Query -
Creates and returns a new Query{@link Query} with the additional filter
that documents should satisfy the relation constraint provided. Documents
must contain the field specified in the filter.
inherited
-
whereFieldPath(
JSAny fieldPath, String opStr, JSAny value) → Query -
Creates and returns a new Query with the additional filter that documents
must contain the specified field and that its value should satisfy the
relation constraint provided.
inherited
-
withConverter(
FirestoreDataConverter? converter) → CollectionGroup -
Partitions a query by returning partition cursors that can be used to run
the query in parallel. The returned cursors are split points that can be
used as starting and end points for individual query invocations.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited