Package-level declarations

The base of the option builders of the pipeline API (stage options, hints and execute options): immutable, each with returns a copy with the option set. Besides the typed options of each builder, with sets an option by name, as the backend knows it.

An aggregate function of the pipeline API, mirroring com.google.firebase.firestore.pipeline.AggregateFunction from the Firebase Android SDK: computed over the input documents (or over each group) by the aggregate stage; name the result with alias.

Hints of an aggregation.

The options of an aggregation.

An aggregation of the input documents, optionally by groups; created with withAccumulators.

An aggregate with an alias, the name of its value in the output documents; created with AggregateFunction.alias.

An expression with an alias, the name of its value in the output documents; created with Expression.alias.

An expression that evaluates to a boolean: a condition of the where stage, of conditional and of countIf.

The options of a collection group source; on Apple platforms only the forced index is supported (see CollectionSourceOptions).

The documents of every collection with an id, the source of com.google.firebase.firestore.PipelineSource.collectionGroup.

Index hints of a collection or collection group source; on Apple platforms only withForceIndex is supported.

The documents of a collection, the source of com.google.firebase.firestore.PipelineSource.collection.

The options of a collection source. On Apple platforms only the forced index (CollectionHints.withForceIndex) is supported; with any other option, executing the pipeline fails with UnsupportedOperationException.

An expression of the pipeline API, mirroring com.google.firebase.firestore.pipeline.Expression from the Firebase Android SDK: a field reference, a constant, or a function of the pipeline backend over other expressions. The functions of the companion object create them; the member functions apply the companion function of the same name to this expression, as its first argument. A function taking a field name instead of an expression applies to that field; a value of type Any becomes a constant (see constant).

A reference to a field of the input documents, created with Expression.field; as a Selectable its alias is the field path.

The options of a nearest-neighbour search.

A nearest-neighbour search of a vector field.

A function of the pipeline backend, by its name and arguments.

Literal documents, the source of com.google.firebase.firestore.PipelineSource.literals: each map is one input document, its values constants or expressions (also nested in maps and lists), converted when the pipeline is executed.

The order of a sort: an expression and a direction; created with Expression.ascending and Expression.descending.

Options by name, for an option of AbstractOptions.with that takes nested options; start from DEFAULT.

A stage by its backend name and arguments, for stages this SDK has no method for; created with ofName.

A random sample of the input documents; created with withDocLimit or withPercentage.

A full-text or geo search; created with withQuery. Beta in the Android SDK.

An expression that names a field of the output documents of a stage: a Field, or an expression with an alias.

A stage of a Pipeline: immutable, withOption returns a copy with an option of the stage set.

The documents of a subcollection of each input document, the source of a subquery; created with of.

The options of Pipeline.unnest.

One output document per element of an array; created with withField.