React Native Firebase
    Preparing search index...

    Interface Pipeline<T>Beta

    Pipeline with chained stages. Each stage returns a new Pipeline (immutable chain).

    interface Pipeline<T = DocumentData> {
        addFields(...field: Selectable[]): Pipeline<T>;
        addFields(options: { field: Selectable[] }): Pipeline<T>;
        aggregate(...accumulator: AliasedAggregate[]): Pipeline<T>;
        aggregate(options: PipelineAggregateOptions): Pipeline<T>;
        define(
            aliasedExpression: AliasedExpression,
            ...additionalExpressions: AliasedExpression[],
        ): Pipeline<T>;
        define(options: DefineStageOptions): Pipeline<T>;
        define(options: PipelineDefineOptions): Pipeline<T>;
        distinct(...group: (string | Field)[]): Pipeline<T>;
        distinct(options: PipelineDistinctOptions): Pipeline<T>;
        findNearest(options: PipelineFindNearestOptions): Pipeline<T>;
        limit(n: number): Pipeline<T>;
        limit(options: { n: number }): Pipeline<T>;
        offset(n: number): Pipeline<T>;
        offset(options: { n: number }): Pipeline<T>;
        rawStage(
            name: string,
            params: Record<string, unknown>,
            options?: PipelineRawStageOptions,
        ): Pipeline<T>;
        removeFields(...field: (string | Field)[]): Pipeline<T>;
        removeFields(options: { field: (string | Field)[] }): Pipeline<T>;
        replaceWith(fieldName: string): Pipeline<T>;
        replaceWith(expr: Selectable): Pipeline<T>;
        replaceWith(options: PipelineReplaceWithOptions): Pipeline<T>;
        sample(n: number): Pipeline<T>;
        sample(options: PipelineSampleOptions): Pipeline<T>;
        search(options: PipelineSearchOptions): Pipeline<T>;
        search(options: SearchStageOptions): Pipeline<T>;
        select(...selection: (string | Selectable)[]): Pipeline<T>;
        select(options: { selection: (string | Selectable)[] }): Pipeline<T>;
        serialize(): FirestorePipelineSerializedInternal;
        sort(...ordering: Ordering[]): Pipeline<T>;
        sort(options: { ordering: Ordering[] }): Pipeline<T>;
        toArrayExpression(): FunctionExpression;
        toScalarExpression(): FunctionExpression;
        union(otherPipeline: Pipeline<T>): Pipeline<T>;
        union(options: PipelineUnionOptions<T>): Pipeline<T>;
        unnest(selectable: Selectable, indexField?: string): Pipeline<T>;
        unnest(options: PipelineUnnestOptions): Pipeline<T>;
        where(condition: BooleanExpression): Pipeline<T>;
        where(options: { condition: BooleanExpression }): Pipeline<T>;
    }

    Type Parameters

    Index

    Methods

    addFields aggregate define distinct findNearest limit offset rawStage removeFields replaceWith sample search select serialize sort toArrayExpression toScalarExpression union unnest where

    Methods

    • Internal

      Serializes the source + stage chain to the wire format.

      Returns FirestorePipelineSerializedInternal

    Settings

    Member Visibility

    On This Page

    Methods