Classes

LimitBlock

A limit query block that restricts the amount of documents retrieved by a number

OrderByBlock

Order by query block that orders the documents by a property

Query

A query represents an instruction given to the firestore engine to match a specific set of documents within a collection.

QueryBuildBlock

Base behavior for a query block

StartBlock

Initial query block of a query.

WhereBlock

Where clause query block that restricts the query to documents matching the query

Interfaces

ICanPrecedeLimit

Discribes a query block that can create a limit clause as its following block

ICanPrecedeOrderBy

Discribes a query block that can create an order by clause as its following block

ICanPrecedeWhere

Discribes a query block that can create a where clause as its following block

IQueryBuildBlock

Discribes the minimal requirements for a query block

Type Aliases

AggregationResult

Type for the result of an aggregation query

AggregationVerb

Possible aggregation verbs.

  • count: Counts all the documents matching the query
  • sum: gets the sum of all the values in the field
  • average: averages the value in the field
ExplicitAggregationField

Definition for an aggregation query field

ExplicitAggregationQuery

Definition for an aggreagation query

InequalityOperators

Inequality operators

LimitClauseDirection

Limit from for limit clauses

LimitClauseLimit

Limit for Limit clauses

OrderClauseDirection

Direction of the order for order clauses

QueryClauseField

Field name of the query clause

WhereClauseOperator

Operators available for where clauses

WhereClauseValue

Values for where clauses

Variables

inequalityOperators

List of inequality operators

Functions

aggregationQueryToAggregateSpec
isQueryBuildBlock