Skip to content

feat(firestore): Add array expressions #9492

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

Open
milaGGL wants to merge 7 commits into
base: main
Choose a base branch
from
+7,894 −1,377
Open

feat(firestore): Add array expressions #9492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
08bd0e8
add 8 new expressions
milaGGL Feb 11, 2026
19577b1
update the .md files
milaGGL Feb 11, 2026
711c256
format
milaGGL Feb 11, 2026
71be25d
update docs-devsite
milaGGL Feb 12, 2026
4889715
add the remaining 4 expressions
milaGGL Feb 12, 2026
b7d9767
update documentation
milaGGL Feb 13, 2026
d0c864c
update documents
milaGGL Feb 13, 2026
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
144 changes: 144 additions & 0 deletions common/api-review/firestore-lite-pipelines.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,30 @@ export function arrayContainsAny(array: Expression, values: Expression): Boolean
// @beta
export function arrayContainsAny(fieldName: string, values: Expression): BooleanExpression;

// @beta
export function arrayFilter(fieldName: string, variable: string, predicate: BooleanExpression): FunctionExpression;
Copy link
Contributor

@cherylEnkidu cherylEnkidu Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about naming the variable alias in arrayFilter? It may not matter much in the JS SDK, but it would be helpful when porting to Swift, since it would become a labeled parameter there. https://www.hackingwithswift.com/sixty/5/4/parameter-labels


// @beta
export function arrayFilter(arrayExpression: Expression, variable: string, predicate: BooleanExpression): FunctionExpression;

// @beta
export function arrayFirst(fieldName: string): FunctionExpression;

// @beta
export function arrayFirst(arrayExpression: Expression): FunctionExpression;

// @beta
export function arrayFirstN(fieldName: string, n: number): FunctionExpression;

// @beta
export function arrayFirstN(fieldName: string, n: Expression): FunctionExpression;

// @beta
export function arrayFirstN(arrayExpression: Expression, n: number): FunctionExpression;

// @beta
export function arrayFirstN(arrayExpression: Expression, n: Expression): FunctionExpression;

// @beta
export function arrayGet(arrayField: string, offset: number): FunctionExpression;

Expand All @@ -119,12 +143,90 @@ export function arrayGet(arrayExpression: Expression, offset: number): FunctionE
// @beta
export function arrayGet(arrayExpression: Expression, offsetExpr: Expression): FunctionExpression;

// @beta
export function arrayIndexOf(fieldName: string, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayIndexOf(arrayExpression: Expression, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayIndexOfAll(fieldName: string, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayIndexOfAll(arrayExpression: Expression, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayLast(fieldName: string): FunctionExpression;

// @beta
export function arrayLast(arrayExpression: Expression): FunctionExpression;

// @beta
export function arrayLastIndexOf(fieldName: string, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayLastIndexOf(arrayExpression: Expression, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayLastN(fieldName: string, n: number): FunctionExpression;

// @beta
export function arrayLastN(fieldName: string, n: Expression): FunctionExpression;

// @beta
export function arrayLastN(arrayExpression: Expression, n: number): FunctionExpression;

// @beta
export function arrayLastN(arrayExpression: Expression, n: Expression): FunctionExpression;

// @beta
export function arrayLength(fieldName: string): FunctionExpression;

// @beta
export function arrayLength(array: Expression): FunctionExpression;

// @beta
export function arrayMaximum(fieldName: string): FunctionExpression;

// @beta
export function arrayMaximum(arrayExpression: Expression): FunctionExpression;

// @beta
export function arrayMaximumN(fieldName: string, n: number): FunctionExpression;

// @beta
export function arrayMaximumN(fieldName: string, n: Expression): FunctionExpression;

// @beta
export function arrayMaximumN(arrayExpression: Expression, n: number): FunctionExpression;

// @beta
export function arrayMaximumN(arrayExpression: Expression, n: Expression): FunctionExpression;

// @beta
export function arrayMinimum(fieldName: string): FunctionExpression;

// @beta
export function arrayMinimum(arrayExpression: Expression): FunctionExpression;

// @beta
export function arrayMinimumN(fieldName: string, n: number): FunctionExpression;

// @beta
export function arrayMinimumN(fieldName: string, n: Expression): FunctionExpression;

// @beta
export function arrayMinimumN(arrayExpression: Expression, n: number): FunctionExpression;

// @beta
export function arrayMinimumN(arrayExpression: Expression, n: Expression): FunctionExpression;

// @beta
export function arraySlice(fieldName: string, start: number | Expression, end?: number | Expression): FunctionExpression;

// @beta
export function arraySlice(arrayExpression: Expression, start: number | Expression, end?: number | Expression): FunctionExpression;

// @beta
export function arraySum(fieldName: string): FunctionExpression;

Expand Down Expand Up @@ -391,14 +493,56 @@ export abstract class Expression {
/* Excluded from this release type: _readUserData */
arrayContainsAny(arrayExpression: Expression): BooleanExpression;
/* Excluded from this release type: _readUserData */
arrayFilter(variable: string, predicate: BooleanExpression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayFirst(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayFirstN(n: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayFirstN(n: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayGet(offset: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayGet(offsetExpr: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayIndexOf(search: unknown): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayIndexOf(search: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayIndexOfAll(search: unknown): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayIndexOfAll(search: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLast(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLastIndexOf(search: unknown): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLastIndexOf(search: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLastN(n: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLastN(n: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLength(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMaximum(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMaximumN(n: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMaximumN(n: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMinimum(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMinimumN(n: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMinimumN(n: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayReverse(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arraySlice(start: number, end?: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arraySlice(start: Expression, end?: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arraySum(): FunctionExpression;
/* Excluded from this release type: _readUserData */
as(name: string): AliasedExpression;
Expand Down
144 changes: 144 additions & 0 deletions common/api-review/firestore-pipelines.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,30 @@ export function arrayContainsAny(array: Expression, values: Expression): Boolean
// @beta
export function arrayContainsAny(fieldName: string, values: Expression): BooleanExpression;

// @beta
export function arrayFilter(fieldName: string, variable: string, predicate: BooleanExpression): FunctionExpression;

// @beta
export function arrayFilter(arrayExpression: Expression, variable: string, predicate: BooleanExpression): FunctionExpression;

// @beta
export function arrayFirst(fieldName: string): FunctionExpression;

// @beta
export function arrayFirst(arrayExpression: Expression): FunctionExpression;

// @beta
export function arrayFirstN(fieldName: string, n: number): FunctionExpression;

// @beta
export function arrayFirstN(fieldName: string, n: Expression): FunctionExpression;

// @beta
export function arrayFirstN(arrayExpression: Expression, n: number): FunctionExpression;

// @beta
export function arrayFirstN(arrayExpression: Expression, n: Expression): FunctionExpression;

// @beta
export function arrayGet(arrayField: string, offset: number): FunctionExpression;

Expand All @@ -119,12 +143,90 @@ export function arrayGet(arrayExpression: Expression, offset: number): FunctionE
// @beta
export function arrayGet(arrayExpression: Expression, offsetExpr: Expression): FunctionExpression;

// @beta
export function arrayIndexOf(fieldName: string, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayIndexOf(arrayExpression: Expression, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayIndexOfAll(fieldName: string, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayIndexOfAll(arrayExpression: Expression, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayLast(fieldName: string): FunctionExpression;

// @beta
export function arrayLast(arrayExpression: Expression): FunctionExpression;

// @beta
export function arrayLastIndexOf(fieldName: string, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayLastIndexOf(arrayExpression: Expression, search: unknown | Expression): FunctionExpression;

// @beta
export function arrayLastN(fieldName: string, n: number): FunctionExpression;

// @beta
export function arrayLastN(fieldName: string, n: Expression): FunctionExpression;

// @beta
export function arrayLastN(arrayExpression: Expression, n: number): FunctionExpression;

// @beta
export function arrayLastN(arrayExpression: Expression, n: Expression): FunctionExpression;

// @beta
export function arrayLength(fieldName: string): FunctionExpression;

// @beta
export function arrayLength(array: Expression): FunctionExpression;

// @beta
export function arrayMaximum(fieldName: string): FunctionExpression;

// @beta
export function arrayMaximum(arrayExpression: Expression): FunctionExpression;

// @beta
export function arrayMaximumN(fieldName: string, n: number): FunctionExpression;

// @beta
export function arrayMaximumN(fieldName: string, n: Expression): FunctionExpression;

// @beta
export function arrayMaximumN(arrayExpression: Expression, n: number): FunctionExpression;

// @beta
export function arrayMaximumN(arrayExpression: Expression, n: Expression): FunctionExpression;

// @beta
export function arrayMinimum(fieldName: string): FunctionExpression;

// @beta
export function arrayMinimum(arrayExpression: Expression): FunctionExpression;

// @beta
export function arrayMinimumN(fieldName: string, n: number): FunctionExpression;

// @beta
export function arrayMinimumN(fieldName: string, n: Expression): FunctionExpression;

// @beta
export function arrayMinimumN(arrayExpression: Expression, n: number): FunctionExpression;

// @beta
export function arrayMinimumN(arrayExpression: Expression, n: Expression): FunctionExpression;

// @beta
export function arraySlice(fieldName: string, start: number | Expression, end?: number | Expression): FunctionExpression;

// @beta
export function arraySlice(arrayExpression: Expression, start: number | Expression, end?: number | Expression): FunctionExpression;

// @beta
export function arraySum(fieldName: string): FunctionExpression;

Expand Down Expand Up @@ -394,14 +496,56 @@ export abstract class Expression {
/* Excluded from this release type: _readUserData */
arrayContainsAny(arrayExpression: Expression): BooleanExpression;
/* Excluded from this release type: _readUserData */
arrayFilter(variable: string, predicate: BooleanExpression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayFirst(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayFirstN(n: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayFirstN(n: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayGet(offset: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayGet(offsetExpr: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayIndexOf(search: unknown): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayIndexOf(search: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayIndexOfAll(search: unknown): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayIndexOfAll(search: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLast(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLastIndexOf(search: unknown): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLastIndexOf(search: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLastN(n: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLastN(n: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayLength(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMaximum(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMaximumN(n: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMaximumN(n: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMinimum(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMinimumN(n: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayMinimumN(n: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arrayReverse(): FunctionExpression;
/* Excluded from this release type: _readUserData */
arraySlice(start: number, end?: number): FunctionExpression;
/* Excluded from this release type: _readUserData */
arraySlice(start: Expression, end?: Expression): FunctionExpression;
/* Excluded from this release type: _readUserData */
arraySum(): FunctionExpression;
/* Excluded from this release type: _readUserData */
as(name: string): AliasedExpression;
Expand Down
Loading
Loading