Skip to content

feat(firestore): remove beta tags for pipelines. #9772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wu-hui merged 1 commit into from
Mar 31, 2026
Merged

feat(firestore): remove beta tags for pipelines. #9772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
766 changes: 383 additions & 383 deletions common/api-review/firestore-lite-pipelines.api.md
View file
Open in desktop

Large diffs are not rendered by default.

792 changes: 386 additions & 406 deletions common/api-review/firestore-pipelines.api.md
View file
Open in desktop

Large diffs are not rendered by default.

18 changes: 3 additions & 15 deletions docs-devsite/firestore_lite_pipelines.aggregatefunction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# AggregateFunction class
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

A class that represents an aggregate function.

<b>Signature:</b>
Expand All @@ -25,25 +22,22 @@ export declare class AggregateFunction

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(name, params)](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionconstructor) | | <b><i>(Public Preview)</i></b> Constructs a new instance of the <code>AggregateFunction</code> class |
| [(constructor)(name, params)](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionconstructor) | | Constructs a new instance of the <code>AggregateFunction</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [exprType](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionexprtype) | | [ExpressionType](./firestore_lite_pipelines.md#expressiontype) | <b><i>(Public Preview)</i></b> |
| [exprType](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionexprtype) | | [ExpressionType](./firestore_lite_pipelines.md#expressiontype) | |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [as(name)](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionas) | | <b><i>(Public Preview)</i></b> Assigns an alias to this AggregateFunction. The alias specifies the name that the aggregated value will have in the output document. |
| [as(name)](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionas) | | Assigns an alias to this AggregateFunction. The alias specifies the name that the aggregated value will have in the output document. |

## AggregateFunction.(constructor)

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Constructs a new instance of the `AggregateFunction` class

<b>Signature:</b>
Expand All @@ -61,9 +55,6 @@ constructor(name: string, params: Expression[]);

## AggregateFunction.exprType

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

<b>Signature:</b>

```typescript
Expand All @@ -72,9 +63,6 @@ exprType: ExpressionType;

## AggregateFunction.as()

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Assigns an alias to this AggregateFunction. The alias specifies the name that the aggregated value will have in the output document.

<b>Signature:</b>
Expand Down
18 changes: 3 additions & 15 deletions docs-devsite/firestore_lite_pipelines.aliasedaggregate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# AliasedAggregate class
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

An AggregateFunction with alias.

<b>Signature:</b>
Expand All @@ -25,20 +22,17 @@ export declare class AliasedAggregate

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(aggregate, alias, \_methodName)](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregateconstructor) | | <b><i>(Public Preview)</i></b> Constructs a new instance of the <code>AliasedAggregate</code> class |
| [(constructor)(aggregate, alias, \_methodName)](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregateconstructor) | | Constructs a new instance of the <code>AliasedAggregate</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [aggregate](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregateaggregate) | | [AggregateFunction](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunction_class) | <b><i>(Public Preview)</i></b> |
| [alias](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregatealias) | | string | <b><i>(Public Preview)</i></b> |
| [aggregate](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregateaggregate) | | [AggregateFunction](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunction_class) | |
| [alias](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregatealias) | | string | |

## AliasedAggregate.(constructor)

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Constructs a new instance of the `AliasedAggregate` class

<b>Signature:</b>
Expand All @@ -57,9 +51,6 @@ constructor(aggregate: AggregateFunction, alias: string, _methodName: string | u

## AliasedAggregate.aggregate

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

<b>Signature:</b>

```typescript
Expand All @@ -68,9 +59,6 @@ readonly aggregate: AggregateFunction;

## AliasedAggregate.alias

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

<b>Signature:</b>

```typescript
Expand Down
29 changes: 5 additions & 24 deletions docs-devsite/firestore_lite_pipelines.aliasedexpression.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# AliasedExpression class
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>


<b>Signature:</b>

```typescript
Expand All @@ -25,22 +21,19 @@ export declare class AliasedExpression implements Selectable

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(expr, alias, \_methodName)](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionconstructor) | | <b><i>(Public Preview)</i></b> Constructs a new instance of the <code>AliasedExpression</code> class |
| [(constructor)(expr, alias, \_methodName)](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionconstructor) | | Constructs a new instance of the <code>AliasedExpression</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [alias](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionalias) | | string | <b><i>(Public Preview)</i></b> |
| [expr](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionexpr) | | [Expression](./firestore_lite_pipelines.expression.md#expression_class) | <b><i>(Public Preview)</i></b> |
| [exprType](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionexprtype) | | [ExpressionType](./firestore_lite_pipelines.md#expressiontype) | <b><i>(Public Preview)</i></b> |
| [selectable](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionselectable) | | true | <b><i>(Public Preview)</i></b> |
| [alias](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionalias) | | string | |
| [expr](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionexpr) | | [Expression](./firestore_lite_pipelines.expression.md#expression_class) | |
| [exprType](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionexprtype) | | [ExpressionType](./firestore_lite_pipelines.md#expressiontype) | |
| [selectable](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionselectable) | | true | |

## AliasedExpression.(constructor)

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Constructs a new instance of the `AliasedExpression` class

<b>Signature:</b>
Expand All @@ -59,9 +52,6 @@ constructor(expr: Expression, alias: string, _methodName: string | undefined);

## AliasedExpression.alias

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

<b>Signature:</b>

```typescript
Expand All @@ -70,9 +60,6 @@ readonly alias: string;

## AliasedExpression.expr

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

<b>Signature:</b>

```typescript
Expand All @@ -81,9 +68,6 @@ readonly expr: Expression;

## AliasedExpression.exprType

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

<b>Signature:</b>

```typescript
Expand All @@ -92,9 +76,6 @@ exprType: ExpressionType;

## AliasedExpression.selectable

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

<b>Signature:</b>

```typescript
Expand Down
38 changes: 7 additions & 31 deletions docs-devsite/firestore_lite_pipelines.booleanexpression.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# BooleanExpression class
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

An interface that represents a filter condition.

<b>Signature:</b>
Expand All @@ -26,19 +23,16 @@ export declare abstract class BooleanExpression extends Expression

| Method | Modifiers | Description |
| --- | --- | --- |
| [conditional(thenExpr, elseExpr)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressionconditional) | | <b><i>(Public Preview)</i></b> Creates a conditional expression that evaluates to the 'then' expression if <code>this</code> expression evaluates to <code>true</code>, or evaluates to the 'else' expression if <code>this</code> expressions evaluates <code>false</code>. |
| [countIf()](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioncountif) | | <b><i>(Public Preview)</i></b> Creates an aggregation that finds the count of input documents satisfying this boolean expression. |
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | <b><i>(Public Preview)</i></b> Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | <b><i>(Public Preview)</i></b> Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | <b><i>(Public Preview)</i></b> Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | <b><i>(Public Preview)</i></b> Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
| [not()](./firestore_lite_pipelines.booleanexpression.md#booleanexpressionnot) | | <b><i>(Public Preview)</i></b> Creates an expression that negates this boolean expression. |
| [conditional(thenExpr, elseExpr)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressionconditional) | | Creates a conditional expression that evaluates to the 'then' expression if <code>this</code> expression evaluates to <code>true</code>, or evaluates to the 'else' expression if <code>this</code> expressions evaluates <code>false</code>. |
| [countIf()](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioncountif) | | Creates an aggregation that finds the count of input documents satisfying this boolean expression. |
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
| [not()](./firestore_lite_pipelines.booleanexpression.md#booleanexpressionnot) | | Creates an expression that negates this boolean expression. |

## BooleanExpression.conditional()

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Creates a conditional expression that evaluates to the 'then' expression if `this` expression evaluates to `true`<!-- -->, or evaluates to the 'else' expression if `this` expressions evaluates `false`<!-- -->.

<b>Signature:</b>
Expand Down Expand Up @@ -71,9 +65,6 @@ field("age").greaterThanOrEqual(18).conditional(constant("Adult"), constant("Min

## BooleanExpression.countIf()

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Creates an aggregation that finds the count of input documents satisfying this boolean expression.

<b>Signature:</b>
Expand All @@ -98,9 +89,6 @@ field("score").greaterThan(90).countIf().as("highestScore");

## BooleanExpression.ifError()

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Creates an expression that returns the `catch` argument if there is an error, else return the result of this expression.

<b>Signature:</b>
Expand Down Expand Up @@ -133,9 +121,6 @@ constant(50).divide(field('length')).greaterThan(1).ifError(constant(false));

## BooleanExpression.ifError()

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Creates an expression that returns the `catch` argument if there is an error, else return the result of this expression.

<b>Signature:</b>
Expand Down Expand Up @@ -168,9 +153,6 @@ constant(50).divide(field('length')).greaterThan(1).ifError(false);

## BooleanExpression.ifError()

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Creates an expression that returns the `catch` argument if there is an error, else return the result of this expression.

<b>Signature:</b>
Expand Down Expand Up @@ -202,9 +184,6 @@ constant(50).divide(field('length')).greaterThan(1).ifError(constant(0));

## BooleanExpression.ifError()

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Creates an expression that returns the `catch` argument if there is an error, else return the result of this expression.

<b>Signature:</b>
Expand Down Expand Up @@ -236,9 +215,6 @@ constant(50).divide(field('length')).greaterThan(1).ifError(0);

## BooleanExpression.not()

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>

Creates an expression that negates this boolean expression.

<b>Signature:</b>
Expand Down
Loading
Loading