Learn how Firestore can scale to power your enterprise applications, now with MongoDB compatibility. Learn more in Google Cloud.

Чтобы переводить контент на ваш предпочитаемый язык, Google использует технологии на основе искусственного интеллекта. Переводы от ИИ могут содержать ошибки.

Все функции

Агрегирование

Все агрегатные функции можно использовать как выражения верхнего уровня на этапе aggregate(...).

Имя	Описание
`COUNT`	Возвращает количество документов.
`COUNT_IF`	Возвращает количество документов, для которых выражение оценивается как `TRUE`.
`COUNT_DISTINCT`	Возвращает количество уникальных значений, не равных `NULL`.
`SUM`	Возвращает сумму всех значений `NUMERIC`.
`AVERAGE`	Возвращает среднее значение всех значений `NUMERIC`.
`MINIMUM`	Возвращает минимальное значение, не равное `NULL`.
`MAXIMUM`	Возвращает максимальное значение, не равное `NULL`.
`FIRST`	Возвращает значение `expression` для первого документа.
`LAST`	Возвращает значение `expression` для последнего документа.
`ARRAY_AGG`	Возвращает массив всех входных значений.
`ARRAY_AGG_DISTINCT`	Возвращает массив всех уникальных входных значений.

COUNT

Синтаксис:

count() -> INT64
count(expression: ANY) -> INT64

Описание.

Возвращает количество документов из предыдущего этапа, где expression оценивается как любое значение, отличное от NULL. Если expression не указано, возвращает общее количество документов из предыдущего этапа.

Node.js

// Total number of books in the collection
const countOfAll = await db.pipeline()
  .collection("books")
  .aggregate(countAll().as("count"))
  .execute();

// Number of books with nonnull `ratings` field
const countField = await db.pipeline()
  .collection("books")
  .aggregate(field("ratings").count().as("count"))
  .execute();test.firestore.js

Web

// Total number of books in the collection
const countOfAll = await execute(db.pipeline()
  .collection("books")
  .aggregate(countAll().as("count"))
);

// Number of books with nonnull `ratings` field
const countField = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("ratings").count().as("count"))
);test.firestore.js

Swift

// Total number of books in the collection
let countAll = try await db.pipeline()
  .collection("books")
  .aggregate([CountAll().as("count")])
  .execute()

// Number of books with nonnull `ratings` field
let countField = try await db.pipeline()
  .collection("books")
  .aggregate([Field("ratings").count().as("count")])
  .execute()PipelineSnippets.swift

Kotlin

// Total number of books in the collection
val countAll = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.countAll().alias("count"))
    .execute()

// Number of books with nonnull `ratings` field
val countField = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.count("ratings").alias("count"))
    .execute()DocSnippets.kt

Java

// Total number of books in the collection
Task<Pipeline.Snapshot> countAll = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.countAll().alias("count"))
    .execute();

// Number of books with nonnull `ratings` field
Task<Pipeline.Snapshot> countField = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.count("ratings").alias("count"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Count

# Total number of books in the collection
count_all = (
    client.pipeline().collection("books").aggregate(Count().as_("count")).execute()
)

# Number of books with nonnull `ratings` field
count_field = (
    client.pipeline()
    .collection("books")
    .aggregate(Count("ratings").as_("count"))
    .execute()
)firestore_pipelines.py

Java

// Total number of books in the collection
Pipeline.Snapshot countAll =
    firestore.pipeline().collection("books").aggregate(countAll().as("count")).execute().get();

// Number of books with nonnull `ratings` field
Pipeline.Snapshot countField =
    firestore
        .pipeline()
        .collection("books")
        .aggregate(count("ratings").as("count"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

// Total number of books in the collection
countAll, err := client.Pipeline().Collection("books").
	Aggregate(firestore.Accumulators(firestore.CountAll().As("count"))).
	Execute(ctx).Results().GetAll()
if err != nil {
	fmt.Fprintf(w, "GetAll failed: %v", err)
	return err
}

// Number of books with nonnull `ratings` field
countField, err := client.Pipeline().
	Collection("books").
	Aggregate(firestore.Accumulators(firestore.Count("ratings").As("count"))).
	Execute(ctx).Results().GetAll()
if err != nil {
	fmt.Fprintf(w, "GetAll failed: %v", err)
	return err
}pipeline_snippets_accumulators_aggregation.go

COUNT_IF

Синтаксис:

count_if(expression: BOOLEAN) -> INT64

Описание.

Возвращает количество документов из предыдущего этапа, где expression оценивается как TRUE.

Node.js

const result = await db.pipeline()
  .collection("books")
  .aggregate(
    field("rating").greaterThan(4).countIf().as("filteredCount")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(
    field("rating").greaterThan(4).countIf().as("filteredCount")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .aggregate([
    AggregateFunction("count_if", [Field("rating").greaterThan(4)]).as("filteredCount")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .aggregate(
        AggregateFunction.countIf(field("rating").greaterThan(4)).alias("filteredCount")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .aggregate(
        AggregateFunction.countIf(field("rating").greaterThan(4)).alias("filteredCount")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .aggregate(Field.of("rating").greater_than(4).count_if().as_("filteredCount"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .aggregate(countIf(field("rating").greaterThan(4)).as("filteredCount"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Aggregate(firestore.Accumulators(
		firestore.CountIf(firestore.FieldOf("rating").GreaterThan(4)).As("filteredCount"),
	)).
	Execute(ctx)pipeline_snippets_accumulators_aggregation.go

COUNT_DISTINCT

Синтаксис:

count_distinct(expression: ANY) -> INT64

Описание.

Возвращает количество уникальных значений expression, не равных NULL и ABSENT.

Node.js

const result = await db.pipeline()
  .collection("books")
  .aggregate(field("author").countDistinct().as("unique_authors"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("author").countDistinct().as("unique_authors"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .aggregate([AggregateFunction("count_distinct", [Field("author")]).as("unique_authors")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.countDistinct("author").alias("unique_authors"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.countDistinct("author").alias("unique_authors"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .aggregate(Field.of("author").count_distinct().as_("unique_authors"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .aggregate(countDistinct("author").as("unique_authors"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Aggregate(firestore.Accumulators(
		firestore.CountDistinct("author").As("unique_authors"),
	)).
	Execute(ctx)pipeline_snippets_accumulators_aggregation.go

SUM

Синтаксис:

sum(expression: ANY) -> NUMBER

Описание.

Возвращает сумму всех числовых значений, игнорируя нечисловые. Возвращает NaN, если любое из значений равно NaN.

Выходные данные будут иметь тот же тип, что и входные данные самого широкого типа, за исключением следующих случаев:

Если значение INTEGER нельзя представить в виде INTEGER, оно будет преобразовано в DOUBLE.

Node.js

const result = await db.pipeline()
  .collection("cities")
  .aggregate(field("population").sum().as("totalPopulation"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("cities")
  .aggregate(field("population").sum().as("totalPopulation"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("cities")
  .aggregate([Field("population").sum().as("totalPopulation")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("cities")
    .aggregate(AggregateFunction.sum("population").alias("totalPopulation"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("cities")
    .aggregate(AggregateFunction.sum("population").alias("totalPopulation"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("cities")
    .aggregate(Field.of("population").sum().as_("totalPopulation"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("cities")
        .aggregate(sum("population").as("totalPopulation"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("cities").
	Aggregate(firestore.Accumulators(
		firestore.Sum("population").As("totalPopulation"),
	)).
	Execute(ctx)pipeline_snippets_array.go

СРЕДНЕЕ

Синтаксис:

average(expression: ANY) -> FLOAT64

Описание.

Возвращает среднее значение для всех числовых значений, игнорируя нечисловые. Возвращает NaN, если любое из значений равно NaN, или NULL, если числовые значения не агрегированы.

Тип выходных данных будет совпадать с типом входных данных, за исключением следующих случаев:

Если значение INTEGER нельзя представить в виде INTEGER, оно будет преобразовано в DOUBLE.

Node.js

const result = await db.pipeline()
  .collection("cities")
  .aggregate(field("population").average().as("averagePopulation"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("cities")
  .aggregate(field("population").average().as("averagePopulation"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("cities")
  .aggregate([Field("population").average().as("averagePopulation")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("cities")
    .aggregate(AggregateFunction.average("population").alias("averagePopulation"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("cities")
    .aggregate(AggregateFunction.average("population").alias("averagePopulation"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("cities")
    .aggregate(Field.of("population").average().as_("averagePopulation"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("cities")
        .aggregate(average("population").as("averagePopulation"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("cities").
	Aggregate(firestore.Accumulators(
		firestore.Average("population").As("averagePopulation"),
	)).
	Execute(ctx)pipeline_snippets_accumulators_aggregation.go

МИНИМУМ

Синтаксис:

minimum(expression: ANY) -> ANY

Описание.

Возвращает минимальное значение expression, которое не равно NULL и не отсутствует, при оценке каждого документа.

Если все значения равны NULL или отсутствуют, возвращается NULL. в том числе когда документы не учитываются.

Если минимальных эквивалентных значений несколько, может быть возвращено любое из них. Типы значений упорядочены в соответствии с документацией.

Node.js

const result = await db.pipeline()
  .collection("books")
  .aggregate(field("price").minimum().as("minimumPrice"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("price").minimum().as("minimumPrice"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .aggregate([Field("price").minimum().as("minimumPrice")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.minimum("price").alias("minimumPrice"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.minimum("price").alias("minimumPrice"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .aggregate(Field.of("price").minimum().as_("minimumPrice"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .aggregate(minimum("price").as("minimumPrice"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Aggregate(firestore.Accumulators(
		firestore.Minimum("price").As("minimumPrice"),
	)).
	Execute(ctx)pipeline_snippets_array.go

МАКСИМУМ

Синтаксис:

maximum(expression: ANY) -> ANY

Описание.

Возвращает максимальное значение expression, которое не равно NULL и не отсутствует, при оценке каждого документа.

Если все значения равны NULL или отсутствуют, возвращается NULL. в том числе когда документы не учитываются.

Если максимальных значений несколько, может быть возвращено любое из них. Типы значений упорядочены в соответствии с документацией.

Node.js

const result = await db.pipeline()
  .collection("books")
  .aggregate(field("price").maximum().as("maximumPrice"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("price").maximum().as("maximumPrice"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .aggregate([Field("price").maximum().as("maximumPrice")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.maximum("price").alias("maximumPrice"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.maximum("price").alias("maximumPrice"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .aggregate(Field.of("price").maximum().as_("maximumPrice"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .aggregate(maximum("price").as("maximumPrice"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Aggregate(firestore.Accumulators(
		firestore.Maximum("price").As("maximumPrice"),
	)).
	Execute(ctx)pipeline_snippets_array.go

FIRST

Синтаксис:

first(expression: ANY) -> ANY

Описание.

Возвращает значение expression для первого возвращенного документа.

ПОСЛЕДНИЙ

Синтаксис:

last(expression: ANY) -> ANY

Описание.

Возвращает значение expression для последнего возвращенного документа.

ARRAY_AGG

Синтаксис:

array_agg(expression: ANY) -> ARRAY<ANY>

Описание.

Возвращает массив, содержащий все значения expression, полученные при оценке каждого документа.

Если выражение разрешается в отсутствующее значение, оно преобразуется в NULL.

Порядок элементов в выходном массиве не является стабильным, и на него не следует полагаться.

ARRAY_AGG_DISTINCT

Синтаксис:

array_agg_distinct(expression: ANY) -> ARRAY<ANY>

Описание.

Возвращает массив, содержащий все уникальные значения expression, полученные при оценке каждого документа.

Если выражение разрешается в отсутствующее значение, оно преобразуется в NULL.

Порядок элементов в выходном массиве не является стабильным, и на него не следует полагаться.

Арифметические функции

Все арифметические функции в Cloud Firestore работают следующим образом:

Возвращает NULL, если любой из входных параметров равен NULL.
Возвращает NaN, если любой из аргументов равен NaN.
Если происходит переполнение или антипереполнение, генерируется ошибка.

Cloud Firestore выполняет расширение числового типа на основе следующей иерархии: INT32 < INT64 < FLOAT64 < DECIMAL128. Если арифметическая функция принимает несколько числовых аргументов разных типов (например, add(5.0D, 6L)), более узкие типы неявно преобразуются в самый широкий тип, присутствующий среди операндов. В предыдущем примере тип 6L расширяется до 6.0D, в результате чего выражение возвращает тип FLOAT64.

Неявное приведение типа INT64 -> FLOAT64 может привести к потере точности, поскольку приводимое значение может потерять свои наименее значимые биты. Полученное значение будет округленной версией исходного целого числа, полученной с использованием режима округления до ближайшего значения IEEE 754.

Имя	Описание
`ABS`	Возвращает абсолютное значение `number`.
`ADD`	Возвращает значение `x + y`.
`SUBTRACT`	Возвращает значение `x - y`.
`MULTIPLY`	Возвращает значение `x * y`.
`DIVIDE`	Возвращает значение `x / y`.
`MOD`	Возвращает остаток от деления `x / y`
`CEIL`	Возвращает округленное в большую сторону значение `number`.
`FLOOR`	Возвращает округленное в меньшую сторону значение `number`.
`ROUND`	Округляет `number` до `places` десятичных знаков.
`TRUNC`	Округляет значение `number` до `places` знаков после запятой.
`POW`	Возвращает значение `base^exponent`.
`SQRT`	Возвращает квадратный корень из `number`.
`EXP`	Возвращает число Эйлера, возведенное в степень `exponent`.
`LN`	Возвращает натуральный логарифм числа `number`.
`LOG`	Возвращает логарифм `number`
`LOG10`	Возвращает логарифм числа `number` по основанию `10`.
`RAND`	Возвращает псевдослучайное число с плавающей запятой.

ABS

Синтаксис:

abs[N <: INT32 | INT64 | FLOAT64](number: N) -> N

Описание.

Возвращает абсолютное значение number.

Если функция переполняет значение INT32 или INT64, выдается ошибка.

Примеры

Число	`abs(number)`
10	10
-10	10
10L	10L
-0,0	0.0
10.5	10.5
-10,5	10.5
-2³¹	`[error]`
-2⁶³	`[error]`

ДОБАВИТЬ

Синтаксис:

add[N <: INT32 | INT64 | FLOAT64](x: N, y: N) -> N

Описание.

Возвращает значение x + y.

Примеры

X	Y	`add(x, y)`
20	3	23
10,0	1	11.0
22,5	2.0	24,5
INT64.MAX	1	`[error]`
INT64.MIN	-1	`[error]`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("soldBooks").add(field("unsoldBooks")).as("totalBooks"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("soldBooks").add(field("unsoldBooks")).as("totalBooks"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("soldBooks").add(Field("unsoldBooks")).as("totalBooks")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(Expression.add(field("soldBooks"), field("unsoldBooks")).alias("totalBooks"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(Expression.add(field("soldBooks"), field("unsoldBooks")).alias("totalBooks"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("soldBooks").add(Field.of("unsoldBooks")).as_("totalBooks"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(add(field("soldBooks"), field("unsoldBooks")).as("totalBooks"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Add(firestore.FieldOf("soldBooks"), firestore.FieldOf("unsoldBooks")).As("totalBooks"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

SUBTRACT

Синтаксис:

subtract[N <: INT32 | INT64 | FLOAT64](x: N, y: N) -> N

Описание.

Возвращает значение x - y.

Примеры

X	Y	`subtract(x, y)`
20	3	17
10,0	1	9.0
22,5	2.0	20,5
INT64.MAX	-1	`[error]`
INT64.MIN	1	`[error]`

Node.js

const storeCredit = 7;
const result = await db.pipeline()
  .collection("books")
  .select(field("price").subtract(constant(storeCredit)).as("totalCost"))
  .execute();test.firestore.js

Web

const storeCredit = 7;
const result = await execute(db.pipeline()
  .collection("books")
  .select(field("price").subtract(constant(storeCredit)).as("totalCost"))
);test.firestore.js

Swift

let storeCredit = 7
let result = try await db.pipeline()
  .collection("books")
  .select([Field("price").subtract(Constant(storeCredit)).as("totalCost")])
  .execute()PipelineSnippets.swift

Kotlin

val storeCredit = 7
val result = db.pipeline()
    .collection("books")
    .select(Expression.subtract(field("price"), storeCredit).alias("totalCost"))
    .execute()DocSnippets.kt

Java

int storeCredit = 7;
Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(Expression.subtract(field("price"), storeCredit).alias("totalCost"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

store_credit = 7
result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("price").subtract(store_credit).as_("totalCost"))
    .execute()
)firestore_pipelines.py

Java

int storeCredit = 7;
Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(subtract(field("price"), storeCredit).as("totalCost"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

storeCredit := 7
snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Subtract(firestore.FieldOf("price"), storeCredit).As("totalCost"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

MULTIPLY

Синтаксис:

multiply[N <: INT32 | INT64 | FLOAT64](x: N, y: N) -> N

Описание.

Возвращает значение x * y.

Примеры

X	Y	`multiply(x, y)`
20	3	60
10,0	1	10,0
22,5	2.0	45.0
INT64.MAX	2	`[error]`
INT64.MIN	2	`[error]`
FLOAT64.MAX	FLOAT64.MAX	`+inf`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("price").multiply(field("soldBooks")).as("revenue"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("price").multiply(field("soldBooks")).as("revenue"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("price").multiply(Field("soldBooks")).as("revenue")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(Expression.multiply(field("price"), field("soldBooks")).alias("revenue"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(Expression.multiply(field("price"), field("soldBooks")).alias("revenue"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("price").multiply(Field.of("soldBooks")).as_("revenue"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(multiply(field("price"), field("soldBooks")).as("revenue"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Multiply(firestore.FieldOf("price"), firestore.FieldOf("soldBooks")).As("revenue"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

DIVIDE

Синтаксис:

divide[N <: INT32 | INT64 | FLOAT64](x: N, y: N) -> N

Описание.

Возвращает значение x / y. Целочисленное деление усекается.

Примеры

X	Y	`divide(x, y)`
20	3	6
10,0	3	3,333...
22,5	2	11,25
10	0	`[error]`
1.0	0.0	`+inf`
-1,0	0.0	`-inf`
0.0	0.0	`NaN`
`+inf`	`+inf`	`NaN`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("ratings").divide(field("soldBooks")).as("reviewRate"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("ratings").divide(field("soldBooks")).as("reviewRate"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("ratings").divide(Field("soldBooks")).as("reviewRate")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(Expression.divide(field("ratings"), field("soldBooks")).alias("reviewRate"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(Expression.divide(field("ratings"), field("soldBooks")).alias("reviewRate"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("ratings").divide(Field.of("soldBooks")).as_("reviewRate"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(divide(field("ratings"), field("soldBooks")).as("reviewRate"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Divide(firestore.FieldOf("ratings"), firestore.FieldOf("soldBooks")).As("reviewRate"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

СТАТУС

Синтаксис:

mod[N <: INT32 | INT64 | FLOAT64](x: N, y: N) -> N

Описание.

Возвращает остаток от деления x / y.

Выдает ошибку error, если y равно нулю для целочисленных типов (INT64).
Возвращает NaN, если y равно нулю для типов с плавающей запятой (FLOAT64).

Примеры

X	Y	`mod(x, y)`
20	3	2
-10	3	-1
10	-3	1
-10	-3	-1
10	1	0
22,5	2	0,5
22,5	0.0	`NaN`
25	0	`[error]`

Node.js

const displayCapacity = 1000;
const result = await db.pipeline()
  .collection("books")
  .select(field("unsoldBooks").mod(constant(displayCapacity)).as("warehousedBooks"))
  .execute();test.firestore.js

Web

const displayCapacity = 1000;
const result = await execute(db.pipeline()
  .collection("books")
  .select(field("unsoldBooks").mod(constant(displayCapacity)).as("warehousedBooks"))
);test.firestore.js

Swift

let displayCapacity = 1000
let result = try await db.pipeline()
  .collection("books")
  .select([Field("unsoldBooks").mod(Constant(displayCapacity)).as("warehousedBooks")])
  .execute()PipelineSnippets.swift

Kotlin

val displayCapacity = 1000
val result = db.pipeline()
    .collection("books")
    .select(Expression.mod(field("unsoldBooks"), displayCapacity).alias("warehousedBooks"))
    .execute()DocSnippets.kt

Java

int displayCapacity = 1000;
Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(Expression.mod(field("unsoldBooks"), displayCapacity).alias("warehousedBooks"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

display_capacity = 1000
result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("unsoldBooks").mod(display_capacity).as_("warehousedBooks"))
    .execute()
)firestore_pipelines.py

Java

int displayCapacity = 1000;
Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(mod(field("unsoldBooks"), displayCapacity).as("warehousedBooks"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

displayCapacity := 1000
snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Mod(firestore.FieldOf("unsoldBooks"), displayCapacity).As("warehousedBooks"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

CEIL

Синтаксис:

ceil[N <: INT32 | INT64 | FLOAT64](number: N) -> N

Описание.

Возвращает наименьшее целое число, которое больше или равно number.

Примеры

Число	`ceil(number)`
20	20
10	10
0	0
24L	24L
-0,4	-0,0
0,4	1.0
22,5	23.0
`NaN`	`NaN`
`+inf`	`+inf`
`-inf`	`-inf`

Node.js

const booksPerShelf = 100;
const result = await db.pipeline()
  .collection("books")
  .select(
    field("unsoldBooks").divide(constant(booksPerShelf)).ceil().as("requiredShelves")
  )
  .execute();test.firestore.js

Web

const booksPerShelf = 100;
const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("unsoldBooks").divide(constant(booksPerShelf)).ceil().as("requiredShelves")
  )
);test.firestore.js

Swift

let booksPerShelf = 100
let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("unsoldBooks").divide(Constant(booksPerShelf)).ceil().as("requiredShelves")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val booksPerShelf = 100
val result = db.pipeline()
    .collection("books")
    .select(
        Expression.divide(field("unsoldBooks"), booksPerShelf).ceil().alias("requiredShelves")
    )
    .execute()DocSnippets.kt

Java

int booksPerShelf = 100;
Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        Expression.divide(field("unsoldBooks"), booksPerShelf).ceil().alias("requiredShelves")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

books_per_shelf = 100
result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("unsoldBooks")
        .divide(books_per_shelf)
        .ceil()
        .as_("requiredShelves")
    )
    .execute()
)firestore_pipelines.py

Java

int booksPerShelf = 100;
Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(ceil(divide(field("unsoldBooks"), booksPerShelf)).as("requiredShelves"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

booksPerShelf := 100
snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Ceil(firestore.Divide(firestore.FieldOf("unsoldBooks"), booksPerShelf)).As("requiredShelves"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

FLOOR

Синтаксис:

floor[N <: INT32 | INT64 | FLOAT64](number: N) -> N

Описание.

Возвращает наибольшее целое число, которое не превышает number.

Примеры

Число	`floor(number)`
20	20
10	10
0	0
2147483648	2147483648
-0,4	-1,0
0,4	0.0
22,5	22.0
`NaN`	`NaN`
`+inf`	`+inf`
`-inf`	`-inf`

Node.js

const result = await db.pipeline()
  .collection("books")
  .addFields(
    field("wordCount").divide(field("pages")).floor().as("wordsPerPage")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .addFields(
    field("wordCount").divide(field("pages")).floor().as("wordsPerPage")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .addFields([
    Field("wordCount").divide(Field("pages")).floor().as("wordsPerPage")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .addFields(
        Expression.divide(field("wordCount"), field("pages")).floor().alias("wordsPerPage")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .addFields(
        Expression.divide(field("wordCount"), field("pages")).floor().alias("wordsPerPage")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .add_fields(
        Field.of("wordCount").divide(Field.of("pages")).floor().as_("wordsPerPage")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .addFields(floor(divide(field("wordCount"), field("pages"))).as("wordsPerPage"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	AddFields(firestore.Selectables(
		firestore.Floor(firestore.Divide(firestore.FieldOf("wordCount"), firestore.FieldOf("pages"))).As("wordsPerPage"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

ROUND

Синтаксис:

round[N <: INT32 | INT64 | FLOAT64 | DECIMAL128](number: N) -> N
round[N <: INT32 | INT64 | FLOAT64 | DECIMAL128](number: N, places: INT64) -> N

Описание.

Округляет число number до places знаков после запятой. Если значение places положительное, округляются цифры справа от десятичной запятой, а если отрицательное – слева.

Если указано только значение number, округляет до ближайшего целого числа.
Округляет до ближайшего целого числа, большего по модулю.
Если округление с отрицательным значением places приводит к переполнению, выдается ошибка error.

Примеры

Число	места	`round(number, places)`
15,5	0	16.0
-15,5	0	-16,0
15	1	15
15	0	15
15	-1	20
15	-2	0
15.48924	1	15,5
2³¹-1	-1	`[error]`
2⁶³-1L	-1	`[error]`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("soldBooks").multiply(field("price")).round().as("partialRevenue"))
  .aggregate(field("partialRevenue").sum().as("totalRevenue"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("soldBooks").multiply(field("price")).round().as("partialRevenue"))
  .aggregate(field("partialRevenue").sum().as("totalRevenue"))
  );test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("soldBooks").multiply(Field("price")).round().as("partialRevenue")])
  .aggregate([Field("partialRevenue").sum().as("totalRevenue")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(Expression.multiply(field("soldBooks"), field("price")).round().alias("partialRevenue"))
    .aggregate(AggregateFunction.sum("partialRevenue").alias("totalRevenue"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(Expression.multiply(field("soldBooks"), field("price")).round().alias("partialRevenue"))
    .aggregate(AggregateFunction.sum("partialRevenue").alias("totalRevenue"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("soldBooks")
        .multiply(Field.of("price"))
        .round()
        .as_("partialRevenue")
    )
    .aggregate(Field.of("partialRevenue").sum().as_("totalRevenue"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(round(multiply(field("soldBooks"), field("price"))).as("partialRevenue"))
        .aggregate(sum("partialRevenue").as("totalRevenue"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Round(firestore.Multiply(firestore.FieldOf("soldBooks"), firestore.FieldOf("price"))).As("partialRevenue"),
	)).
	Aggregate(firestore.Accumulators(
		firestore.Sum("partialRevenue").As("totalRevenue"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

TRUNC

Синтаксис:

trunc[N <: Number](number: N) -> N
trunc[N <: Number](number:  N, places: INT64) -> N

Описание.

Усекает значение number до указанного количества places десятичных знаков. Если значение places положительное, то усекаются цифры справа от десятичной запятой, а если отрицательное – слева.

Если указан только аргумент number, округляет до ближайшего целого числа в сторону нуля.
Если усечение приводит к переполнению, выдается ошибка error.

Примеры

Число	места	`trunc(number, places)`
15,5	0	15.0
-15,5	0	-15,0
15	1	15
15	0	15
15	-1	10
15	-2	0
15.48924	1	15,4
-15,48924	2	-15,48

POW

Синтаксис:

pow(base: FLOAT64, exponent: FLOAT64) -> FLOAT64

Описание.

Возвращает значение base, возведенное в степень exponent.

Если base <= 0 и exponent отрицательные, выдается ошибка.
Для любого exponent (включая NaN) pow(1, exponent) равно 1.
Для любого base (включая NaN) pow(base, 0) равно 1.

Примеры

основание	основание натурального логарифма	`pow(base, exponent)`
2	3	8.0
2	-3	0,125
`+inf`	0	1.0
1	`+inf`	1.0
`NaN`	0	1.0
1	`NaN`	1.0
`NaN`	`Numeric`	`NaN`
`Numeric`	`NaN`	`NaN`
-1	0,5	`[error]`
0	-1	`[error]`

Node.js

const googleplex = { latitude: 37.4221, longitude: 122.0853 };
const result = await db.pipeline()
  .collection("cities")
  .addFields(
    field("lat").subtract(constant(googleplex.latitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("latitudeDifference"),
    field("lng").subtract(constant(googleplex.longitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("longitudeDifference")
  )
  .select(
    field("latitudeDifference").add(field("longitudeDifference")).sqrt()
      // Inaccurate for large distances or close to poles
      .as("approximateDistanceToGoogle")
  )
  .execute();test.firestore.js

Web

const googleplex = { latitude: 37.4221, longitude: 122.0853 };
const result = await execute(db.pipeline()
  .collection("cities")
  .addFields(
    field("lat").subtract(constant(googleplex.latitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("latitudeDifference"),
    field("lng").subtract(constant(googleplex.longitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("longitudeDifference")
  )
  .select(
    field("latitudeDifference").add(field("longitudeDifference")).sqrt()
      // Inaccurate for large distances or close to poles
      .as("approximateDistanceToGoogle")
  )
);test.firestore.js

Swift

let googleplex = CLLocation(latitude: 37.4221, longitude: 122.0853)
let result = try await db.pipeline()
  .collection("cities")
  .addFields([
    Field("lat").subtract(Constant(googleplex.coordinate.latitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("latitudeDifference"),
    Field("lng").subtract(Constant(googleplex.coordinate.latitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("longitudeDifference")
  ])
  .select([
    Field("latitudeDifference").add(Field("longitudeDifference")).sqrt()
      // Inaccurate for large distances or close to poles
      .as("approximateDistanceToGoogle")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val googleplex = GeoPoint(37.4221, -122.0853)
val result = db.pipeline()
    .collection("cities")
    .addFields(
        field("lat").subtract(googleplex.latitude)
            .multiply(111) // km per degree
            .pow(2)
            .alias("latitudeDifference"),
        field("lng").subtract(googleplex.longitude)
            .multiply(111) // km per degree
            .pow(2)
            .alias("longitudeDifference")
    )
    .select(
        field("latitudeDifference").add(field("longitudeDifference")).sqrt()
            // Inaccurate for large distances or close to poles
            .alias("approximateDistanceToGoogle")
    )
    .execute()DocSnippets.kt

Java

GeoPoint googleplex = new GeoPoint(37.4221, -122.0853);
Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("cities")
    .addFields(
        field("lat").subtract(googleplex.getLatitude())
            .multiply(111 /* km per degree */)
            .pow(2)
            .alias("latitudeDifference"),
        field("lng").subtract(googleplex.getLongitude())
            .multiply(111 /* km per degree */)
            .pow(2)
            .alias("longitudeDifference")
    )
    .select(
        field("latitudeDifference").add(field("longitudeDifference")).sqrt()
            // Inaccurate for large distances or close to poles
            .alias("approximateDistanceToGoogle")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

googleplexLat = 37.4221
googleplexLng = -122.0853
result = (
    client.pipeline()
    .collection("cities")
    .add_fields(
        Field.of("lat")
        .subtract(googleplexLat)
        .multiply(111)  # km per degree
        .pow(2)
        .as_("latitudeDifference"),
        Field.of("lng")
        .subtract(googleplexLng)
        .multiply(111)  # km per degree
        .pow(2)
        .as_("longitudeDifference"),
    )
    .select(
        Field.of("latitudeDifference")
        .add(Field.of("longitudeDifference"))
        .sqrt()
        # Inaccurate for large distances or close to poles
        .as_("approximateDistanceToGoogle")
    )
    .execute()
)firestore_pipelines.py

Java

double googleplexLat = 37.4221;
double googleplexLng = -122.0853;
Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("cities")
        .addFields(
            pow(multiply(subtract(field("lat"), googleplexLat), 111), 2)
                .as("latitudeDifference"),
            pow(multiply(subtract(field("lng"), googleplexLng), 111), 2)
                .as("longitudeDifference"))
        .select(
            sqrt(add(field("latitudeDifference"), field("longitudeDifference")))
                // Inaccurate for large distances or close to poles
                .as("approximateDistanceToGoogle"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

googleplexLat := 37.4221
googleplexLng := -122.0853
snapshot := client.Pipeline().
	Collection("cities").
	AddFields(firestore.Selectables(
		firestore.Pow(firestore.Multiply(firestore.Subtract(firestore.FieldOf("lat"), googleplexLat), 111), 2).As("latitudeDifference"),
		firestore.Pow(firestore.Multiply(firestore.Subtract(firestore.FieldOf("lng"), googleplexLng), 111), 2).As("longitudeDifference"),
	)).
	Select(firestore.Fields(
		firestore.Sqrt(firestore.Add(firestore.FieldOf("latitudeDifference"), firestore.FieldOf("longitudeDifference"))).
			// Inaccurate for large distances or close to poles
			As("approximateDistanceToGoogle"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

SQRT

Синтаксис:

sqrt[N <: FLOAT64 | DECIMAL128](number: N) -> N

Описание.

Возвращает квадратный корень из number.

Если number – отрицательное число, выдается ошибка error.

Примеры

Число	`sqrt(number)`
25	5.0
12.002	3,464…
0.0	0.0
`NaN`	`NaN`
`+inf`	`+inf`
`-inf`	`[error]`
`x < 0`	`[error]`

Node.js

const googleplex = { latitude: 37.4221, longitude: 122.0853 };
const result = await db.pipeline()
  .collection("cities")
  .addFields(
    field("lat").subtract(constant(googleplex.latitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("latitudeDifference"),
    field("lng").subtract(constant(googleplex.longitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("longitudeDifference")
  )
  .select(
    field("latitudeDifference").add(field("longitudeDifference")).sqrt()
      // Inaccurate for large distances or close to poles
      .as("approximateDistanceToGoogle")
  )
  .execute();test.firestore.js

Web

const googleplex = { latitude: 37.4221, longitude: 122.0853 };
const result = await execute(db.pipeline()
  .collection("cities")
  .addFields(
    field("lat").subtract(constant(googleplex.latitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("latitudeDifference"),
    field("lng").subtract(constant(googleplex.longitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("longitudeDifference")
  )
  .select(
    field("latitudeDifference").add(field("longitudeDifference")).sqrt()
      // Inaccurate for large distances or close to poles
      .as("approximateDistanceToGoogle")
  )
);test.firestore.js

Swift

let googleplex = CLLocation(latitude: 37.4221, longitude: 122.0853)
let result = try await db.pipeline()
  .collection("cities")
  .addFields([
    Field("lat").subtract(Constant(googleplex.coordinate.latitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("latitudeDifference"),
    Field("lng").subtract(Constant(googleplex.coordinate.latitude))
      .multiply(111 /* km per degree */)
      .pow(2)
      .as("longitudeDifference")
  ])
  .select([
    Field("latitudeDifference").add(Field("longitudeDifference")).sqrt()
      // Inaccurate for large distances or close to poles
      .as("approximateDistanceToGoogle")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val googleplex = GeoPoint(37.4221, -122.0853)
val result = db.pipeline()
    .collection("cities")
    .addFields(
        field("lat").subtract(googleplex.latitude)
            .multiply(111) // km per degree
            .pow(2)
            .alias("latitudeDifference"),
        field("lng").subtract(googleplex.longitude)
            .multiply(111) // km per degree
            .pow(2)
            .alias("longitudeDifference")
    )
    .select(
        field("latitudeDifference").add(field("longitudeDifference")).sqrt()
            // Inaccurate for large distances or close to poles
            .alias("approximateDistanceToGoogle")
    )
    .execute()DocSnippets.kt

Java

GeoPoint googleplex = new GeoPoint(37.4221, -122.0853);
Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("cities")
    .addFields(
        field("lat").subtract(googleplex.getLatitude())
            .multiply(111 /* km per degree */)
            .pow(2)
            .alias("latitudeDifference"),
        field("lng").subtract(googleplex.getLongitude())
            .multiply(111 /* km per degree */)
            .pow(2)
            .alias("longitudeDifference")
    )
    .select(
        field("latitudeDifference").add(field("longitudeDifference")).sqrt()
            // Inaccurate for large distances or close to poles
            .alias("approximateDistanceToGoogle")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

googleplexLat = 37.4221
googleplexLng = -122.0853
result = (
    client.pipeline()
    .collection("cities")
    .add_fields(
        Field.of("lat")
        .subtract(googleplexLat)
        .multiply(111)  # km per degree
        .pow(2)
        .as_("latitudeDifference"),
        Field.of("lng")
        .subtract(googleplexLng)
        .multiply(111)  # km per degree
        .pow(2)
        .as_("longitudeDifference"),
    )
    .select(
        Field.of("latitudeDifference")
        .add(Field.of("longitudeDifference"))
        .sqrt()
        # Inaccurate for large distances or close to poles
        .as_("approximateDistanceToGoogle")
    )
    .execute()
)firestore_pipelines.py

Java

double googleplexLat = 37.4221;
double googleplexLng = -122.0853;
Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("cities")
        .addFields(
            pow(multiply(subtract(field("lat"), googleplexLat), 111), 2)
                .as("latitudeDifference"),
            pow(multiply(subtract(field("lng"), googleplexLng), 111), 2)
                .as("longitudeDifference"))
        .select(
            sqrt(add(field("latitudeDifference"), field("longitudeDifference")))
                // Inaccurate for large distances or close to poles
                .as("approximateDistanceToGoogle"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

googleplexLat := 37.4221
googleplexLng := -122.0853
snapshot := client.Pipeline().
	Collection("cities").
	AddFields(firestore.Selectables(
		firestore.Pow(firestore.Multiply(firestore.Subtract(firestore.FieldOf("lat"), googleplexLat), 111), 2).As("latitudeDifference"),
		firestore.Pow(firestore.Multiply(firestore.Subtract(firestore.FieldOf("lng"), googleplexLng), 111), 2).As("longitudeDifference"),
	)).
	Select(firestore.Fields(
		firestore.Sqrt(firestore.Add(firestore.FieldOf("latitudeDifference"), firestore.FieldOf("longitudeDifference"))).
			// Inaccurate for large distances or close to poles
			As("approximateDistanceToGoogle"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

EXP

Синтаксис:

exp(exponent: FLOAT64) -> FLOAT64

Описание.

Возвращает число Эйлера, возведенное в степень exponent. Также называется натуральной экспоненциальной функцией.

Примеры

основание натурального логарифма	`exp(exponent)`
0.0	1.0
10	`e^10` (`FLOAT64`)
`NaN`	`NaN`
`+inf`	`+inf`
`-inf`	0

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("rating").exp().as("expRating"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("rating").exp().as("expRating"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("rating").exp().as("expRating")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("rating").exp().alias("expRating"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("rating").exp().alias("expRating"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").exp().as_("expRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(exp(field("rating")).as("expRating"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Exp(firestore.FieldOf("rating")).As("expRating"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

LN

Синтаксис:

ln(number: FLOAT64) -> FLOAT64

Описание.

Возвращает натуральный логарифм number. Эта функция эквивалентна log(number).

Примеры

Число	`ln(number)`
1	0.0
2L	0,693…
1.0	0.0
`e` (`FLOAT64`)	1.0
`NaN`	`NaN`
`-inf`	`NaN`
`+inf`	`+inf`
`x <= 0`	`[error]`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("rating").ln().as("lnRating"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("rating").ln().as("lnRating"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("rating").ln().as("lnRating")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("rating").ln().alias("lnRating"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("rating").ln().alias("lnRating"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").ln().as_("lnRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(ln(field("rating")).as("lnRating"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Ln(firestore.FieldOf("rating")).As("lnRating"),
	)).
	Execute(ctx)pipeline_snippets_arithmetic.go

LOG

Синтаксис:

log(number: FLOAT64, base: FLOAT64) -> FLOAT64
log(number: FLOAT64) -> FLOAT64

Описание.

Возвращает логарифм number по основанию base.

Если указан только аргумент number, возвращает логарифм number по основанию base (синоним ln(number)).

Примеры

Число	основание	`log(number, base)`
100	10	2.0
`NaN`	`Numeric`	`NaN`
`Numeric`	`NaN`	`NaN`
`-inf`	`Numeric`	`NaN`
`Numeric`.	`+inf`	`NaN`
`number <= 0`	`Numeric`	`[error]`
`Numeric`	`base <= 0`	`[error]`
`Numeric`	1.0	`[error]`

LOG10

Синтаксис:

log10(x: FLOAT64) -> FLOAT64

Описание.

Возвращает логарифм числа number по основанию 10.

Примеры

Число	`log10(number)`
100	2.0
`NaN`	`NaN`
`-inf`	`NaN`
`+inf`	`+inf`
`x <= 0`	`[error]`

RAND

Синтаксис:

rand() -> FLOAT64

Описание.

Возвращает псевдослучайное число с плавающей запятой, выбранное равномерно между 0.0 (включительно) и 1.0 (исключительно).

Функции массивов

Имя	Описание
`ARRAY`	Возвращает `ARRAY`, содержащий по одному элементу для каждого входного аргумента.
`ARRAY_CONCAT`	Объединяет несколько массивов в один `ARRAY`
`ARRAY_CONTAINS`	Возвращает `TRUE`, если заданный `ARRAY` содержит определенное значение.
`ARRAY_CONTAINS_ALL`	Возвращает `TRUE`, если все значения присутствуют в `ARRAY`.
`ARRAY_CONTAINS_ANY`	Возвращает `TRUE`, если в `ARRAY` есть хотя бы одно из значений.
`ARRAY_FILTER`	Отфильтровывает элементы из `ARRAY`, которые не соответствуют предикату.
`ARRAY_FIRST`	Возвращает первый элемент в `ARRAY`.
`ARRAY_FIRST_N`	Возвращает первые `n` элементов в `ARRAY`.
`ARRAY_GET`	Возвращает элемент с заданным индексом в `ARRAY`.
`ARRAY_INDEX_OF`	Возвращает индекс первого вхождения значения в `ARRAY`.
`ARRAY_INDEX_OF_ALL`	Возвращает все индексы значения в `ARRAY`.
`ARRAY_LENGTH`	Возвращает количество элементов в `ARRAY`.
`ARRAY_LAST`	Возвращает последний элемент в `ARRAY`.
`ARRAY_LAST_N`	Возвращает последние `n` элементов в `ARRAY`.
`ARRAY_REVERSE`	Меняет порядок элементов в `ARRAY` на обратный.
`ARRAY_SLICE`	Возвращает фрагмент `ARRAY`
`ARRAY_TRANSFORM`	Преобразует элементы в `ARRAY`, применяя выражение к каждому элементу.
`MAXIMUM`	Возвращает максимальное значение в `ARRAY`.
`MAXIMUM_N`	Возвращает `n` наибольших значений в `ARRAY`.
`MINIMUM`	Возвращает минимальное значение в `ARRAY`.
`MINIMUM_N`	Возвращает `n` наименьших значений в `ARRAY`.
`SUM`	Возвращает сумму всех значений `NUMERIC` в `ARRAY`.
`JOIN`	Объединяет элементы в `ARRAY` как значение `STRING`.

ARRAY

Синтаксис:

array(values: ANY...) -> ARRAY

Описание.

Создает массив из указанных элементов.

Если аргумент не существует, в результирующем массиве он заменяется на NULL.

Примеры

values	`array(values)`
()	[]
(1, 2, 3)	[1, 2, 3]
("a", 1, true)	["a", 1, true]
(1, null)	[1, null]
(1, [2, 3])	[1, [2, 3]]

ARRAY_CONCAT

Синтаксис:

array_concat(arrays: ARRAY...) -> ARRAY

Описание.

Объединяет два или более массивов в один ARRAY.

Примеры

массивы	`array_concat(arrays)`
([1, 2], [3, 4])	[1, 2, 3, 4]
(["a", "b"], ["c"])	["a", "b", "c"]
([1], [2], [3])	[1, 2, 3]
([], [1, 2])	[1, 2]

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("genre").arrayConcat([field("subGenre")]).as("allGenres"))
  .execute();test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("genre").arrayConcat([Field("subGenre")]).as("allGenres")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("genre").arrayConcat(field("subGenre")).alias("allGenres"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("genre").arrayConcat(field("subGenre")).alias("allGenres"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("genre").array_concat(Field.of("subGenre")).as_("allGenres"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(arrayConcat(field("genre"), field("subGenre")).as("allGenres"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.ArrayConcat(firestore.FieldOf("genre"), firestore.FieldOf("subGenre")).As("allGenres"),
	)).
	Execute(ctx)pipeline_snippets_array.go

ARRAY_CONTAINS

Синтаксис:

array_contains(array: ARRAY, value: ANY) -> BOOLEAN

Описание.

Возвращает TRUE, если value найдено в array, и FALSE в противном случае.

Примеры

Массив	value	`array_contains(array, value)`
[1, 2, 3]	2	true
[[1, 2], [3]]	[1, 2]	true
[1, null]	null	true
"abc"	ЛЮБАЯ	ошибка

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("genre").arrayContains(constant("mystery")).as("isMystery"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("genre").arrayContains(constant("mystery")).as("isMystery"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("genre").arrayContains(Constant("mystery")).as("isMystery")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("genre").arrayContains("mystery").alias("isMystery"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("genre").arrayContains("mystery").alias("isMystery"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("genre").array_contains("mystery").as_("isMystery"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(arrayContains(field("genre"), "mystery").as("isMystery"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.ArrayContains(firestore.FieldOf("genre"), "mystery").As("isMystery"),
	)).
	Execute(ctx)pipeline_snippets_array.go

ARRAY_CONTAINS_ALL

Синтаксис:

array_contains_all(array: ARRAY, search_values: ARRAY) -> BOOLEAN

Описание.

Возвращает TRUE, если все значения search_values найдены в array, и FALSE в противном случае.

Примеры

Массив	search_values	`array_contains_all(array, search_values)`
[1, 2, 3]	[1, 2]	true
[1, 2, 3]	[1, 4]	false
[1, null]	[ноль]	true
[NaN]	[NaN]	true
[]	[]	true
[1, 2, 3]	[]	true

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("genre")
      .arrayContainsAll([constant("fantasy"), constant("adventure")])
      .as("isFantasyAdventure")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("genre")
      .arrayContainsAll([constant("fantasy"), constant("adventure")])
      .as("isFantasyAdventure")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("genre")
      .arrayContainsAll([Constant("fantasy"), Constant("adventure")])
      .as("isFantasyAdventure")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("genre")
            .arrayContainsAll(listOf("fantasy", "adventure"))
            .alias("isFantasyAdventure")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("genre")
            .arrayContainsAll(Arrays.asList("fantasy", "adventure"))
            .alias("isFantasyAdventure")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("genre")
        .array_contains_all(["fantasy", "adventure"])
        .as_("isFantasyAdventure")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(
            arrayContainsAll(field("genre"), Arrays.asList("fantasy", "adventure"))
                .as("isFantasyAdventure"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.ArrayContainsAll(firestore.FieldOf("genre"), []string{"fantasy", "adventure"}).As("isFantasyAdventure"),
	)).
	Execute(ctx)pipeline_snippets_array.go

ARRAY_CONTAINS_ANY

Синтаксис:

array_contains_any(array: ARRAY, search_values: ARRAY) -> BOOLEAN

Описание.

Возвращает TRUE, если в array найдены любые из search_values, и FALSE в противном случае.

Примеры

Массив	search_values	`array_contains_any(array, search_values)`
[1, 2, 3]	[4, 1]	true
[1, 2, 3]	[4, 5]	false
[1, 2, null]	[ноль]	true

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("genre")
      .arrayContainsAny([constant("fantasy"), constant("nonfiction")])
      .as("isMysteryOrFantasy")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("genre")
      .arrayContainsAny([constant("fantasy"), constant("nonfiction")])
      .as("isMysteryOrFantasy")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("genre")
      .arrayContainsAny([Constant("fantasy"), Constant("nonfiction")])
      .as("isMysteryOrFantasy")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("genre")
            .arrayContainsAny(listOf("fantasy", "nonfiction"))
            .alias("isMysteryOrFantasy")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("genre")
            .arrayContainsAny(Arrays.asList("fantasy", "nonfiction"))
            .alias("isMysteryOrFantasy")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("genre")
        .array_contains_any(["fantasy", "nonfiction"])
        .as_("isMysteryOrFantasy")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(
            arrayContainsAny(field("genre"), Arrays.asList("fantasy", "nonfiction"))
                .as("isMysteryOrFantasy"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.ArrayContainsAny(firestore.FieldOf("genre"), []string{"fantasy", "nonfiction"}).As("isMysteryOrFantasy"),
	)).
	Execute(ctx)pipeline_snippets_array.go

ARRAY_FILTER

Синтаксис:

array_filter(array: ARRAY, predicate: (ANY) -> BOOLEAN) -> ARRAY

Описание.

Фильтрует array с помощью выражения predicate, возвращая новый массив, содержащий только элементы, которые соответствуют предикату.

Для каждого элемента в array вычисляется predicate. Если возвращается значение true, элемент включается в результат, а если false или null – пропускается.
Если predicate возвращает не логическое значение и не null, функция возвращает ошибку.

Примеры

Массив	предикат	`array_filter(array, predicate)`
[1, 2, 3]	x -> x > 1	[2, 3]
[1, null, 3]	x -> x > 1	[3]
["a", "b", "c"]	x -> x != "b"	["a", "c"]
[]	x -> true	[]

ARRAY_GET

Синтаксис:

array_get(array: ARRAY, index: INT64) -> ANY

Описание.

Возвращает элемент с индексом index (начиная с нуля) в массиве array.

Если значение index отрицательное, элементы выбираются с конца массива, где -1 – последний элемент.
Если array не относится к типу ARRAY и не является null, возвращается ошибка.
Если значение index выходит за допустимые пределы, функция возвращает отсутствующее значение.
Если index не относится к типу INT64, функция возвращает ошибку.

Примеры

Массив	индекс	`array_get(array, index)`
[1, 2, 3]	0	1
[1, 2, 3]	-1	3
[1, 2, 3]	3	отсутствует
[1, 2, 3]	-4	отсутствует
"abc"	0	ошибка
null	0	null
`Array`	"a"	ошибка
`Array`	2.0	ошибка

ARRAY_LENGTH

Синтаксис:

array_length(array: ARRAY) -> INT64

Описание.

Возвращает количество элементов в array.

Примеры

Массив	`array_length(array)`
[1, 2, 3]	3
[]	0
[1, 1, 1]	3
[1, null]	2

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("genre").arrayLength().as("genreCount"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("genre").arrayLength().as("genreCount"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("genre").arrayLength().as("genreCount")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("genre").arrayLength().alias("genreCount"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("genre").arrayLength().alias("genreCount"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("genre").array_length().as_("genreCount"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(arrayLength(field("genre")).as("genreCount"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.ArrayLength(firestore.FieldOf("genre")).As("genreCount"),
	)).
	Execute(ctx)pipeline_snippets_array.go

ARRAY_REVERSE

Синтаксис:

array_reverse(array: ARRAY) -> ARRAY

Описание.

Возвращает противоположное значение array.

Примеры

Массив	`array_reverse(array)`
[1, 2, 3]	[3, 2, 1]
["a", "b"]	["b", "a"]
[1, 2, 2, 3]	[3, 2, 2, 1]

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(arrayReverse(field("genre")).as("reversedGenres"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("genre").arrayReverse().as("reversedGenres"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("genre").arrayReverse().as("reversedGenres")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("genre").arrayReverse().alias("reversedGenres"))
    .execute()DocSnippets.kt

    Java
Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("genre").arrayReverse().alias("reversedGenres"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("genre").array_reverse().as_("reversedGenres"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(arrayReverse(field("genre")).as("reversedGenres"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.ArrayReverse(firestore.FieldOf("genre")).As("reversedGenres"),
	)).
	Execute(ctx)pipeline_snippets_array.go

ARRAY_FIRST

Синтаксис:

array_first(array: ARRAY) -> ANY

Описание.

Возвращает первый элемент в array. Это эквивалентно array_get(array, 0).

Если array пусто, возвращает отсутствующее значение.

Примеры

Массив	`array_first(array)`
[1, 2, 3]	1
[]	отсутствует

ARRAY_FIRST_N

Синтаксис:

array_first_n(array: ARRAY, n: INT64) -> ARRAY

Описание.

Возвращает первые элементы n из array. Это эквивалентно array_slice(array, 0, n).

Если n – отрицательное число, возвращается ошибка.

Примеры

Массив	N	`array_first_n(array, n)`
[1, 2, 3, 4, 5]	3	[1, 2, 3]
[1, 2]	3	[1, 2]
[1, 2, 3]	0	[]

ARRAY_INDEX_OF

Синтаксис:

array_index_of(array: ARRAY, value: ANY) -> INT64

Описание.

Возвращает индекс первого вхождения value в array, начиная с 0. Если значение value не найдено, возвращает -1.

Примеры

Массив	value	`array_index_of(array, value)`
[1, 2, 3, 2]	2	1
[1, 2, 3]	4	-1
[1, null, 3]	null	1

ARRAY_INDEX_OF_ALL

Синтаксис:

array_index_of_all(array: ARRAY, value: ANY) -> ARRAY<INT64>

Описание.

Возвращает массив, содержащий индексы (начиная с 0) всех вхождений value в array. Если value не найдено, возвращает [].

Примеры

Массив	value	`array_index_of_all(array, value)`
[1, 2, 3, 2]	2	[1, 3]
[1, 2, 3]	4	[]
[1, null, 3, null]	null	[1, 3]

ARRAY_LAST

Синтаксис:

array_last(array: ARRAY) -> ANY

Описание.

Возвращает последний элемент в array. Это эквивалентно array_get(array, -1).

Если array пусто, возвращает отсутствующее значение.

Примеры

Массив	`array_last(array)`
[1, 2, 3]	3
[]	отсутствует

ARRAY_LAST_N

Синтаксис:

array_last_n(array: ARRAY, n: INT64) -> ARRAY

Описание.

Возвращает последние n элементов из array.

Если n – отрицательное число, возвращается ошибка.

Примеры

Массив	N	`array_last_n(array, n)`
[1, 2, 3, 4, 5]	3	[3, 4, 5]
[1, 2]	3	[1, 2]
[1, 2, 3]	0	[]

ARRAY_SLICE

Синтаксис:

array_slice(array: ARRAY, offset: INT64, length: INT64) -> ARRAY

Описание.

Возвращает подмножество array, начиная с индекса offset (нумерация начинается с нуля) и включая элементы length.

Если значение offset отрицательное, оно указывает на начальную позицию с конца массива, где -1 – последний элемент.
Если значение length больше, чем количество элементов, оставшихся в массиве после offset, результат расширяется до конца массива.
Значение length должно быть неотрицательным, иначе возвращается ошибка.

Примеры

Массив	вычесть	длина	`array_slice(array, offset, length)`
[1, 2, 3, 4, 5]	1	3	[2, 3, 4]
[1, 2, 3, 4, 5]	-2	2	[4, 5]
[1, 2, 3]	1	5	[2, 3]
[1, 2, 3]	3	2	[]

ARRAY_TRANSFORM

Синтаксис:

array_transform(array: ARRAY, expression: (ANY) -> ANY) -> ARRAY
array_transform(array: ARRAY, expression: (ANY, INT64) -> ANY) -> ARRAY

Описание.

Преобразует array, применяя expression к каждому элементу, и возвращает новый массив с преобразованными элементами. Размер выходного массива всегда будет таким же, как и у входного.

expression может быть унарной функцией element -> result или бинарной функцией (element, index) -> result.
Если expression – унарная функция, она вызывается с каждым элементом array.
Если expression – бинарная функция, она вызывается с каждым элементом array и соответствующим ему индексом, начиная с 0.

Примеры

Массив	выражение	`array_transform(array, expression)`
[1, 2, 3]	x -> x * 2	[2, 4, 6]
[1, 2, 3]	x -> x + 1	[2, 3, 4]
[10, 20]	(x, i) -> x + i	[10, 21]
[]	x -> 1	[]

МАКСИМУМ

Синтаксис:

maximum(array: ARRAY) -> ANY

Описание.

Возвращает максимальное значение в array.

Значения NULL игнорируются при сравнении.
Если array пусто или содержит только значения NULL, возвращает NULL.

Примеры

Массив	`maximum(array)`
[1, 5, 2]	5
[1, null, 5]	5
["a", "c", "b"]	"c"
[null, null]	null
[]	null

MAXIMUM_N

Синтаксис:

maximum_n(array: ARRAY, n: INT64) -> ARRAY

Описание.

Возвращает массив из n наибольших значений в array в порядке убывания.

Значения NULL игнорируются.
Если n – отрицательное число, возвращается ошибка.

Примеры

Массив	N	`maximum_n(array, n)`
[1, 5, 2, 4, 3]	3	[5, 4, 3]
[1, null, 5]	3	[5, 1]

МИНИМУМ

Синтаксис:

minimum(array: ARRAY) -> ANY

Описание.

Возвращает минимальное значение в array.

Значения NULL игнорируются при сравнении.
Если array пусто или содержит только значения NULL, возвращает NULL.

Примеры

Массив	`minimum(array)`
[1, 5, 2]	1
[5, null, 1]	1
["a", "c", "b"]	"a"
[null, null]	null
[]	null

MINIMUM_N

Синтаксис:

minimum_n(array: ARRAY, n: INT64) -> ARRAY

Описание.

Возвращает массив из n наименьших значений в array в порядке возрастания.

Значения NULL игнорируются.
Если n – отрицательное число, возвращается ошибка.

Примеры

Массив	N	`minimum_n(array, n)`
[1, 5, 2, 4, 3]	3	[1, 2, 3]
[5, null, 1]	3	[1, 5]

SUM

Синтаксис:

sum(array: ARRAY) -> INT64 | FLOAT64

Описание.

Возвращает сумму всех значений NUMERIC в ARRAY.

Нечисловые значения в массиве игнорируются.
Если какое-либо числовое значение в массиве равно NaN, функция возвращает NaN.
Тип возвращаемого значения определяется самым широким числовым типом в массиве: INT64 < FLOAT64.
Если до суммирования значений с плавающей запятой происходит переполнение 64-битного целого числа, возвращается ошибка. Если суммируются значения с плавающей запятой, переполнение приведет к +/- бесконечности.
Если в массиве нет числовых значений, функция возвращает NULL.

Примеры

Массив	`sum(array)`
[1, 2, 3]	6L
[1L, 2L, 3L]	6L
[2000000000, 2000000000]	4000000000L
[10, 20.5]	30,5
[1, "a", 2]	3L
[INT64.MAX_VALUE, 1]	ошибка
[INT64.MAX_VALUE, 1, -1.0]	ошибка
[INT64.MAX_VALUE, 1.0]	9.223372036854776e+18

ПРИСОЕДИНИТЬСЯ

Синтаксис:

join[T <: STRING | BYTES](array: ARRAY<T>, delimiter: T) -> STRING
join[T <: STRING | BYTES](array: ARRAY<T>, delimiter: T, null_text: T) -> STRING

Описание.

Возвращает объединенные элементы в array как STRING. array может иметь тип данных STRING или BYTES.

Все элементы в array, delimiter и null_text должны быть одного типа: либо STRING, либо BYTES.
Если указан параметр null_text, то все значения NULL в array заменяются на null_text.
Если null_text не указано, значения NULL в array опускаются.

Примеры

Если параметр null_text не указан:

Массив	разделитель	`join(array, delimiter)`
["a", "b", "c"]	","	"a,b,c"
["a", null, "c"]	","	"a,c"
[b'a', b'b', b'c']	b','	b'a,b,c'
["a", b'c']	","	ошибка
["a", "c"]	b','	ошибка
[b'a', b'c']	","	ошибка

Если указан параметр null_text:

Массив	разделитель	null_text	`join(array, delimiter, null_text)`
["a", null, "c"]	","	"MISSING"	"a,MISSING,c"
[b'a', null, b'c']	b','	b'NULL'	b'a,NULL,c'
[null, "b", null]	","	"MISSING"	"MISSING,b,MISSING"
[b'a', null, null]	b','	b'NULL'	b'a,NULL,NULL'
["a", null]	","	b'N'	ошибка
[b'a', null]	b','	"N"	ошибка

Функции сравнения

Имя	Описание
`EQUAL`	Сравнение на равенство
`GREATER_THAN`	Сравнение "больше чем"
`GREATER_THAN_OR_EQUAL`	Сравнение "больше или равно"
`LESS_THAN`	Сравнение "меньше"
`LESS_THAN_OR_EQUAL`	Сравнение "меньше или равно"
`NOT_EQUAL`	Сравнение "не равно"
`CMP`	Общее сравнение

EQUAL

Синтаксис:

equal(x: ANY, y: ANY) -> BOOLEAN

Примеры

`x`	`y`	`equal(x, y)`
1 л	1 л	`TRUE`
1.0	1 л	`TRUE`
-1,0	1 л	`FALSE`
NaN	NaN	`TRUE`
`NULL`	`NULL`	`TRUE`
`NULL`	`ABSENT`	`FALSE`

Описание.

Возвращает TRUE, если x и y равны, и FALSE в противном случае.

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("rating").equal(5).as("hasPerfectRating"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("rating").equal(5).as("hasPerfectRating"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("rating").equal(5).as("hasPerfectRating")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("rating").equal(5).alias("hasPerfectRating"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("rating").equal(5).alias("hasPerfectRating"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").equal(5).as_("hasPerfectRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(equal(field("rating"), 5).as("hasPerfectRating"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Equal(firestore.FieldOf("rating"), 5).As("hasPerfectRating"),
	)).
	Execute(ctx)pipeline_snippets_comparison.go

GREATER_THAN

Синтаксис:

greater_than(x: ANY, y: ANY) -> BOOLEAN

Описание.

Возвращает TRUE, если x больше y, и FALSE в противном случае.

Если x и y нельзя сравнить, возвращает FALSE.

Примеры

`x`	`y`	`greater_than(x, y)`
1 л	0.0	`TRUE`
1 л	1 л	`FALSE`
1 л	2L	`FALSE`
"foo"	0 л	`FALSE`
0 л	"foo"	`FALSE`
NaN	0 л	`FALSE`
0 л	NaN	`FALSE`
`NULL`	`NULL`	`FALSE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("rating").greaterThan(4).as("hasHighRating"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("rating").greaterThan(4).as("hasHighRating"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("rating").greaterThan(4).as("hasHighRating")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("rating").greaterThan(4).alias("hasHighRating"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("rating").greaterThan(4).alias("hasHighRating"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").greater_than(4).as_("hasHighRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(greaterThan(field("rating"), 4).as("hasHighRating"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.GreaterThan(firestore.FieldOf("rating"), 4).As("hasHighRating"),
	)).
	Execute(ctx)pipeline_snippets_comparison.go

GREATER_THAN_OR_EQUAL

Синтаксис:

greater_than_or_equal(x: ANY, y: ANY) -> BOOLEAN

Описание.

Возвращает TRUE, если x больше или равно y, и FALSE в противном случае.

Если x и y нельзя сравнить, возвращает FALSE.

Примеры

`x`	`y`	`greater_than_or_equal(x, y)`
1 л	0.0	`TRUE`
1 л	1 л	`TRUE`
1 л	2L	`FALSE`
"foo"	0 л	`FALSE`
0 л	"foo"	`FALSE`
NaN	0 л	`FALSE`
0 л	NaN	`FALSE`
`NULL`	`NULL`	`TRUE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("published").greaterThanOrEqual(1900).as("publishedIn20thCentury"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("published").greaterThanOrEqual(1900).as("publishedIn20thCentury"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("published").greaterThanOrEqual(1900).as("publishedIn20thCentury")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("published").greaterThanOrEqual(1900).alias("publishedIn20thCentury"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("published").greaterThanOrEqual(1900).alias("publishedIn20thCentury"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("published")
        .greater_than_or_equal(1900)
        .as_("publishedIn20thCentury")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(greaterThanOrEqual(field("published"), 1900).as("publishedIn20thCentury"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.GreaterThanOrEqual(firestore.FieldOf("published"), 1900).As("publishedIn20thCentury"),
	)).
	Execute(ctx)pipeline_snippets_comparison.go

LESS_THAN

Синтаксис:

less_than(x: ANY, y: ANY) -> BOOLEAN

Описание.

Возвращает TRUE, если x меньше y, и FALSE в противном случае.

Если x и y нельзя сравнить, возвращает FALSE.

Примеры

`x`	`y`	`less_than(x, y)`
1 л	0.0	`FALSE`
1 л	1 л	`FALSE`
1 л	2L	`TRUE`
"foo"	0 л	`FALSE`
0 л	"foo"	`FALSE`
NaN	0 л	`FALSE`
0 л	NaN	`FALSE`
`NULL`	`NULL`	`FALSE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("published").lessThan(1923).as("isPublicDomainProbably"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("published").lessThan(1923).as("isPublicDomainProbably"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("published").lessThan(1923).as("isPublicDomainProbably")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("published").lessThan(1923).alias("isPublicDomainProbably"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("published").lessThan(1923).alias("isPublicDomainProbably"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("published").less_than(1923).as_("isPublicDomainProbably"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(lessThan(field("published"), 1923).as("isPublicDomainProbably"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.LessThan(firestore.FieldOf("published"), 1923).As("isPublicDomainProbably"),
	)).
	Execute(ctx)pipeline_snippets_comparison.go

LESS_THAN_OR_EQUAL

Синтаксис:

less_than_or_equal(x: ANY, y: ANY) -> BOOLEAN

Описание.

Возвращает TRUE, если x меньше или равно y, и FALSE в противном случае.

Если x и y нельзя сравнить, возвращает FALSE.

Примеры

`x`	`y`	`less_than(x, y)`
1 л	0.0	`FALSE`
1 л	1 л	`TRUE`
1 л	2L	`TRUE`
"foo"	0 л	`FALSE`
0 л	"foo"	`FALSE`
NaN	0 л	`FALSE`
0 л	NaN	`FALSE`
`NULL`	`NULL`	`TRUE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("rating").lessThanOrEqual(2).as("hasBadRating"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("rating").lessThanOrEqual(2).as("hasBadRating"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("rating").lessThanOrEqual(2).as("hasBadRating")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("rating").lessThanOrEqual(2).alias("hasBadRating"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("rating").lessThanOrEqual(2).alias("hasBadRating"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").less_than_or_equal(2).as_("hasBadRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(lessThanOrEqual(field("rating"), 2).as("hasBadRating"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.LessThanOrEqual(firestore.FieldOf("rating"), 2).As("hasBadRating"),
	)).
	Execute(ctx)pipeline_snippets_comparison.go

NOT_EQUAL

Синтаксис:

not_equal(x: ANY, y: ANY) -> BOOLEAN

Описание.

Возвращает TRUE, если x не равно y, и FALSE в противном случае.

Примеры

`x`	`y`	`not_equal(x, y)`
1 л	1 л	`FALSE`
1.0	1 л	`FALSE`
-1,0	1 л	`TRUE`
NaN	0 л	`TRUE`
NaN	NaN	`FALSE`
`NULL`	`NULL`	`FALSE`
`NULL`	`ABSENT`	`TRUE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("title").notEqual("1984").as("not1984"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("title").notEqual("1984").as("not1984"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("title").notEqual("1984").as("not1984")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("title").notEqual("1984").alias("not1984"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("title").notEqual("1984").alias("not1984"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("title").not_equal("1984").as_("not1984"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(notEqual(field("title"), "1984").as("not1984"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.NotEqual(firestore.FieldOf("title"), "1984").As("not1984"),
	)).
	Execute(ctx)pipeline_snippets_comparison.go

ЗАВ

Синтаксис:

cmp(x: ANY, y: ANY) -> Int64

Описание.

Сравнивает x и y и возвращает:

1L, если x больше y.
-1L, если x меньше y.
В противном случае возвращает 0L.

В отличие от других функций сравнения, cmp(...) работает с разными типами данных, используя тот же порядок, что и на этапе sort(...). Подробнее о том, как упорядочиваются значения разных типов…

Примеры

`x`	`y`	`cmp(x, y)`
1 л	1 л	0 л
1.0	1 л	0 л
-1,0	1 л	-1L
42.5D	"foo"	-1L
`NULL`	`NULL`	0 л
`NULL`	`ABSENT`	0 л

Функции отладки

Имя	Описание
`EXISTS`	Возвращает `TRUE`, если значение не является отсутствующим.
`IS_ABSENT`	Возвращает `TRUE`, если значение отсутствует.
`IF_ABSENT`	Заменяет значение выражением, если оно отсутствует.
`IS_ERROR`	Перехватывает и проверяет, была ли выдана ошибка базовым выражением.
`IF_ERROR`	Заменяет значение выражением, если оно вызвало ошибку.
`ERROR`	Прерывает вычисление и возвращает ошибку с указанным сообщением.

EXISTS

Синтаксис:

exists(value: ANY) -> BOOLEAN

Описание.

Возвращает TRUE, если value не является отсутствующим значением.

Примеры

`value`	`exists(value)`
0 л	`TRUE`
"foo"	`TRUE`
`NULL`	`TRUE`
`ABSENT`	`FALSE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("rating").exists().as("hasRating"))
  .execute();test.firestore.js

Web

Пример

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("rating").exists().as("hasRating"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("rating").exists().as("hasRating")])
  .execute()PipelineSnippets.swift

Kotlin

Пример

val result = db.pipeline()
    .collection("books")
    .select(field("rating").exists().alias("hasRating"))
    .execute()DocSnippets.kt

Java

Пример

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("rating").exists().alias("hasRating"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").exists().as_("hasRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(exists(field("rating")).as("hasRating"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.FieldExists(firestore.FieldOf("rating")).As("hasRating"),
	)).
	Execute(ctx)pipeline_snippets_logical.go

IS_ABSENT

Синтаксис:

is_absent(value: ANY) -> BOOLEAN

Описание.

Возвращает TRUE, если value – отсутствующее значение, и FALSE в противном случае. Отсутствующие значения – это значения, которые не указаны во входных данных, например отсутствующее поле документа.

Примеры

`value`	`is_absent(value)`
0 л	`FALSE`
"foo"	`FALSE`
`NULL`	`FALSE`
`ABSENT`	`TRUE`

IF_ABSENT

Синтаксис:

if_absent(value: ANY, replacement: ANY) -> ANY

Описание.

Если value – отсутствующее значение, вычисляет и возвращает replacement. В противном случае возвращает value.

Примеры

`value`	`replacement`	`if_absent(value, replacement)`
5L	0 л	5L
`NULL`	0 л	`NULL`
`ABSENT`	0 л	0 л

IS_ERROR

Синтаксис:

is_error(try: ANY) -> BOOLEAN

Описание.

Возвращает TRUE, если при вычислении try возникает ошибка. В противном случае возвращает FALSE.

IF_ERROR

Синтаксис:

if_error(try: ANY, catch: ANY) -> ANY

Описание.

Если при вычислении try возникает ошибка, вычисляет и возвращает replacement. В противном случае возвращает распознанное значение try.

ОШИБКА

Синтаксис:

error(message: STRING) -> ANY

Описание.

Выполнение функции error приводит к ошибке в конвейере. В сообщении об ошибке указывается значение message.

Примеры

`cond`	`res`	`switch_on(cond, res, error("no condition matched"))`
`TRUE`	1 л	1 л
`FALSE`	1 л	`ERROR ("no condition matched")`

Функции ссылок

Тип REFERENCE действует как указатель на другие документы в базе данных (или даже на другие базы данных). Приведенные ниже функции позволяют управлять этим типом во время выполнения запроса.

Имя	Описание
`COLLECTION_ID`	Возвращает идентификатор конечной коллекции по указанной ссылке.
`DOCUMENT_ID`	Возвращает идентификатор документа по указанной ссылке.
`PARENT`	Возвращает ссылку на родительский элемент.
`REFERENCE_SLICE`	Возвращает подмножество сегментов из указанного цифрового отпечатка.

COLLECTION_ID

Синтаксис:

collection_id(ref: REFERENCE) -> STRING

Описание.

Возвращает идентификатор дочерней коллекции для указанного объекта REFERENCE.

Примеры

`ref`	`collection_id(ref)`
`users/user1`	`"users"`
`users/user1/posts/post1`	`"posts"`

DOCUMENT_ID

Синтаксис:

document_id(ref: REFERENCE) -> ANY

Описание.

Возвращает идентификатор документа для указанного объекта REFERENCE.

Примеры

`ref`	`document_id(ref)`
`users/user1`	`"user1"`
`users/user1/posts/post1`	`"post1"`

PARENT

Синтаксис:

parent(ref: REFERENCE) -> REFERENCE

Описание.

Возвращает родительский объект REFERENCE для указанной ссылки или NULL, если ссылка уже является корневой.

Примеры

`ref`	`parent(ref)`
`/`	`NULL`
`users/user1`	`/`
`users/user1/posts/post1`	`users/user1`

REFERENCE_SLICE

Синтаксис:

reference_slice(ref: REFERENCE, offset: INT, length: INT) -> REFERENCE

Описание.

REFERENCE – это список кортежей (collection_id, document_id), который позволяет получить представление этого списка, как и array_slice(...).

Возвращает новый объект REFERENCE, который является подмножеством сегментов заданного объекта ref.

offset – начальный индекс (начиная с 0) среза. Если значение отрицательное, то оно указывает на смещение от конца цифрового отпечатка.
length – количество сегментов, которые нужно включить в срез.

Примеры

`ref`	`offset`	`length`	`reference_slice(ref, offset, length)`
`a/1/b/2/c/3`	1 л	2L	`b/2/c/3`
`a/1/b/2/c/3`	0 л	2L	`a/1/b/2`
`a/1/b/2/c/3`	-2L	2L	`c/3`

Логические функции

Имя	Описание
`AND`	Выполняет логическое И.
`OR`	Выполняет логическое ИЛИ.
`XOR`	Выполняет логическую операцию XOR.
`NOT`	Выполняет логическое НЕ.
`NOR`	Выполняет логическую операцию ИЛИ-НЕ.
`CONDITIONAL`	Оценка ветвей на основе условного выражения.
`IF_NULL`	Возвращает первое ненулевое значение.
`SWITCH_ON`	Оценка ветвей на основе ряда условий
`EQUAL_ANY`	Проверяет, равно ли значение какому-либо элементу в массиве.
`NOT_EQUAL_ANY`	Проверяет, не равно ли значение какому-либо элементу в массиве.
`MAXIMUM`	Возвращает максимальное значение из набора значений.
`MINIMUM`	Возвращает минимальное значение из набора значений.

И

Синтаксис:

and(x: BOOLEAN...) -> BOOLEAN

Описание.

Возвращает логическое И двух или более логических значений.

Возвращает NULL, если результат не может быть получен из-за того, что любое из заданных значений равно ABSENT или NULL.

Примеры

`x`	`y`	`and(x, y)`
`TRUE`	`TRUE`	`TRUE`
`FALSE`	`TRUE`	`FALSE`
`NULL`	`TRUE`	`NULL`
`ABSENT`	`TRUE`	`NULL`
`NULL`	`FALSE`	`FALSE`
`FALSE`	`ABSENT`	`FALSE`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    and(field("rating").greaterThan(4), field("price").lessThan(10))
      .as("under10Recommendation")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    and(field("rating").greaterThan(4), field("price").lessThan(10))
      .as("under10Recommendation")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    (Field("rating").greaterThan(4) && Field("price").lessThan(10))
      .as("under10Recommendation")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        Expression.and(field("rating").greaterThan(4),
          field("price").lessThan(10))
            .alias("under10Recommendation")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        Expression.and(
            field("rating").greaterThan(4),
            field("price").lessThan(10)
        ).alias("under10Recommendation")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field, And

result = (
    client.pipeline()
    .collection("books")
    .select(
        And(
            Field.of("rating").greater_than(4), Field.of("price").less_than(10)
        ).as_("under10Recommendation")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(
            and(greaterThan(field("rating"), 4), lessThan(field("price"), 10))
                .as("under10Recommendation"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.And(
			firestore.GreaterThan(firestore.FieldOf("rating"), 4),
			firestore.LessThan(firestore.FieldOf("price"), 10),
		).As("under10Recommendation"),
	)).
	Execute(ctx)pipeline_snippets_logical.go

ИЛИ

Синтаксис:

or(x: BOOLEAN...) -> BOOLEAN

Описание.

Возвращает логическое ИЛИ двух или более логических значений.

Примеры

`x`	`y`	`or(x, y)`
`TRUE`	`TRUE`	`TRUE`
`FALSE`	`TRUE`	`TRUE`
`NULL`	`TRUE`	`TRUE`
`ABSENT`	`TRUE`	`TRUE`
`NULL`	`FALSE`	`NULL`
`FALSE`	`ABSENT`	`NULL`

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    or(field("genre").equal("Fantasy"), field("tags").arrayContains("adventure"))
      .as("matchesSearchFilters")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    or(field("genre").equal("Fantasy"), field("tags").arrayContains("adventure"))
      .as("matchesSearchFilters")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    (Field("genre").equal("Fantasy") || Field("tags").arrayContains("adventure"))
      .as("matchesSearchFilters")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        Expression.or(field("genre").equal("Fantasy"),
          field("tags").arrayContains("adventure"))
            .alias("matchesSearchFilters")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        Expression.or(
            field("genre").equal("Fantasy"),
            field("tags").arrayContains("adventure")
        ).alias("matchesSearchFilters")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field, And, Or

result = (
    client.pipeline()
    .collection("books")
    .select(
        Or(
            Field.of("genre").equal("Fantasy"),
            Field.of("tags").array_contains("adventure"),
        ).as_("matchesSearchFilters")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(
            or(equal(field("genre"), "Fantasy"), arrayContains(field("tags"), "adventure"))
                .as("matchesSearchFilters"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Or(
			firestore.Equal(firestore.FieldOf("genre"), "Fantasy"),
			firestore.ArrayContains(firestore.FieldOf("tags"), "adventure"),
		).As("matchesSearchFilters"),
	)).
	Execute(ctx)pipeline_snippets_logical.go

XOR

Синтаксис:

xor(x: BOOLEAN...) -> BOOLEAN

Описание.

Возвращает логическое исключающее ИЛИ для двух или более логических значений.

Возвращает NULL, если любое из заданных значений равно ABSENT или NULL.

Примеры

`x`	`y`	`xor(x, y)`
`TRUE`	`TRUE`	`FALSE`
`FALSE`	`FALSE`	`FALSE`
`FALSE`	`TRUE`	`TRUE`
`NULL`	`TRUE`	`NULL`
`ABSENT`	`TRUE`	`NULL`
`NULL`	`FALSE`	`NULL`
`FALSE`	`ABSENT`	`NULL`

Node.js

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    xor(field("tags").arrayContains("magic"), field("tags").arrayContains("nonfiction"))
      .as("matchesSearchFilters")
  )
);test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    xor(field("tags").arrayContains("magic"), field("tags").arrayContains("nonfiction"))
      .as("matchesSearchFilters")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    (Field("tags").arrayContains("magic") ^ Field("tags").arrayContains("nonfiction"))
      .as("matchesSearchFilters")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        Expression.xor(field("tags").arrayContains("magic"),
          field("tags").arrayContains("nonfiction"))
            .alias("matchesSearchFilters")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        Expression.xor(
            field("tags").arrayContains("magic"),
            field("tags").arrayContains("nonfiction")
        ).alias("matchesSearchFilters")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field, Xor

result = (
    client.pipeline()
    .collection("books")
    .select(
        Xor(
            [
                Field.of("tags").array_contains("magic"),
                Field.of("tags").array_contains("nonfiction"),
            ]
        ).as_("matchesSearchFilters")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(
            xor(
                    arrayContains(field("tags"), "magic"),
                    arrayContains(field("tags"), "nonfiction"))
                .as("matchesSearchFilters"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Xor(
			firestore.ArrayContains(firestore.FieldOf("tags"), "magic"),
			firestore.ArrayContains(firestore.FieldOf("tags"), "nonfiction"),
		).As("matchesSearchFilters"),
	)).
	Execute(ctx)pipeline_snippets_logical.go

NOR

Синтаксис:

nor(x: BOOLEAN...) -> BOOLEAN

Описание.

Возвращает логическое НЕ ИЛИ для двух или более логических значений.

Примеры

`x`	`y`	`nor(x, y)`
`TRUE`	`TRUE`	`FALSE`
`FALSE`	`TRUE`	`FALSE`
`FALSE`	`FALSE`	`TRUE`
`NULL`	`TRUE`	`FALSE`
`ABSENT`	`TRUE`	`FALSE`
`NULL`	`FALSE`	`NULL`
`FALSE`	`ABSENT`	`NULL`

НЕ

Синтаксис:

not(x: BOOLEAN) -> BOOLEAN

Описание.

Возвращает логическое отрицание логического значения.

Node.js

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("tags").arrayContains("nonfiction").not()
      .as("isFiction")
  )
);test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("tags").arrayContains("nonfiction").not()
      .as("isFiction")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    (!Field("tags").arrayContains("nonfiction"))
      .as("isFiction")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        Expression.not(
            field("tags").arrayContains("nonfiction")
        ).alias("isFiction")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        Expression.not(
            field("tags").arrayContains("nonfiction")
        ).alias("isFiction")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field, Not

result = (
    client.pipeline()
    .collection("books")
    .select(Not(Field.of("tags").array_contains("nonfiction")).as_("isFiction"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(not(arrayContains(field("tags"), "nonfiction")).as("isFiction"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Not(firestore.ArrayContains(firestore.FieldOf("tags"), "nonfiction")).As("isFiction"),
	)).
	Execute(ctx)pipeline_snippets_logical.go

УСЛОВНЫЙ

Синтаксис:

conditional(condition: BOOLEAN, true_case: ANY, false_case: ANY) -> ANY

Описание.

Оценивает и возвращает true_case, если condition оценивается как TRUE.

Проверяет и возвращает false_case, если условие разрешается в FALSE, NULL или значение ABSENT.

Примеры

`condition`	`true_case`	`conditional(condition, true_case, false_case)`
`TRUE`	1 л	1 л
`FALSE`	1 л	0 л
`NULL`	1 л	0 л
`ABSENT`	1 л	0 л

Node.js

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("tags").arrayConcat([
      field("pages").greaterThan(100)
        .conditional(constant("longRead"), constant("shortRead"))
    ]).as("extendedTags")
  )
);test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("tags").arrayConcat([
      field("pages").greaterThan(100)
        .conditional(constant("longRead"), constant("shortRead"))
    ]).as("extendedTags")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("tags").arrayConcat([
      ConditionalExpression(
        Field("pages").greaterThan(100),
        then: Constant("longRead"),
        else: Constant("shortRead")
      )
    ]).as("extendedTags")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("tags").arrayConcat(
            Expression.conditional(
                field("pages").greaterThan(100),
                constant("longRead"),
                constant("shortRead")
            )
        ).alias("extendedTags")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("tags").arrayConcat(
            Expression.conditional(
                field("pages").greaterThan(100),
                constant("longRead"),
                constant("shortRead")
            )
        ).alias("extendedTags")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import (
    Field,
    Constant,
    Conditional,
)

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("tags")
        .array_concat(
            Conditional(
                Field.of("pages").greater_than(100),
                Constant.of("longRead"),
                Constant.of("shortRead"),
            )
        )
        .as_("extendedTags")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(
            arrayConcat(
                    field("tags"),
                    conditional(
                        greaterThan(field("pages"), 100),
                        constant("longRead"),
                        constant("shortRead")))
                .as("extendedTags"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.ArrayConcat(
			firestore.FieldOf("tags"),
			firestore.Conditional(
				firestore.GreaterThan(firestore.FieldOf("pages"), 100),
				firestore.ConstantOf("longRead"),
				firestore.ConstantOf("shortRead"),
			),
		).As("extendedTags"),
	)).
	Execute(ctx)pipeline_snippets_logical.go

IF_NULL

Синтаксис:

if_null(expr: ANY, replacement: ANY) -> ANY

Описание.

Возвращает expr, если это не NULL. В противном случае вычисляет и возвращает replacement. Выражение replacement не вычисляется, если используется expr.

Примеры

`expr`	`replacement`	`if_null(expr, replacement)`
1 л	2L	1 л
`NULL`	2L	2L
`ABSENT`	2L	`ABSENT`

SWITCH_ON

Синтаксис:

switch_on(cond1: BOOLEAN, res1: ANY, cond2: BOOLEAN, res2: ANY, ..., [default: ANY]) -> ANY

Описание.

Проверяет ряд условий и возвращает результат, связанный с первым условием TRUE. Если ни одно из условий не соответствует значению TRUE, возвращается значение default (если оно указано). Если значение default не указано, а другие условия не возвращают TRUE, возникает ошибка.

Чтобы указать значение default, передайте его в качестве последнего аргумента, чтобы количество аргументов было нечетным.

Примеры

`x`	`switch_on(eq(x, 1L), "one", eq(x, 2L), "two", "other")`
1 л	"one"
2L	"two"
3L	"other"

EQUAL_ANY

Синтаксис:

equal_any(value: ANY, search_space: ARRAY) -> BOOLEAN

Описание.

Возвращает TRUE, если value находится в массиве search_space.

Примеры

`value`	`search_space`	`equal_any(value, search_space)`
0 л	[1L, 2L, 3L]	`FALSE`
2L	[1L, 2L, 3L]	`TRUE`
`NULL`	[1L, 2L, 3L]	`FALSE`
`NULL`	[1L, `NULL`]	`TRUE`
`ABSENT`	[1L, `NULL`]	`FALSE`
NaN	[1L, NaN, 3L]	`TRUE`

Node.js

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("genre").equalAny(["Science Fiction", "Psychological Thriller"])
      .as("matchesGenreFilters")
  )
);test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("genre").equalAny(["Science Fiction", "Psychological Thriller"])
      .as("matchesGenreFilters")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("genre").equalAny(["Science Fiction", "Psychological Thriller"])
      .as("matchesGenreFilters")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("genre").equalAny(listOf("Science Fiction", "Psychological Thriller"))
            .alias("matchesGenreFilters")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("genre").equalAny(Arrays.asList("Science Fiction", "Psychological Thriller"))
            .alias("matchesGenreFilters")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("genre")
        .equal_any(["Science Fiction", "Psychological Thriller"])
        .as_("matchesGenreFilters")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(
            equalAny(field("genre"), Arrays.asList("Science Fiction", "Psychological Thriller"))
                .as("matchesGenreFilters"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.EqualAny(firestore.FieldOf("genre"), []string{"Science Fiction", "Psychological Thriller"}).As("matchesGenreFilters"),
	)).
	Execute(ctx)pipeline_snippets_array.go

NOT_EQUAL_ANY

Синтаксис:

not_equal_any(value: ANY, search_space: ARRAY) -> BOOLEAN

Описание.

Возвращает TRUE, если value отсутствует в массиве search_space.

Примеры

`value`	`search_space`	`not_equal_any(value, search_space)`
0 л	[1L, 2L, 3L]	`TRUE`
2L	[1L, 2L, 3L]	`FALSE`
`NULL`	[1L, 2L, 3L]	`TRUE`
`NULL`	[1L, `NULL`]	`FALSE`
`ABSENT`	[1L, `NULL`]	`TRUE`
NaN	[1L, NaN, 3L]	`FALSE`

Node.js

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("author").notEqualAny(["George Orwell", "F. Scott Fitzgerald"])
      .as("byExcludedAuthors")
  )
);test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("author").notEqualAny(["George Orwell", "F. Scott Fitzgerald"])
      .as("byExcludedAuthors")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("author").notEqualAny(["George Orwell", "F. Scott Fitzgerald"])
      .as("byExcludedAuthors")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("author").notEqualAny(listOf("George Orwell", "F. Scott Fitzgerald"))
            .alias("byExcludedAuthors")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("author").notEqualAny(Arrays.asList("George Orwell", "F. Scott Fitzgerald"))
            .alias("byExcludedAuthors")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("author")
        .not_equal_any(["George Orwell", "F. Scott Fitzgerald"])
        .as_("byExcludedAuthors")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(
            notEqualAny(field("author"), Arrays.asList("George Orwell", "F. Scott Fitzgerald"))
                .as("byExcludedAuthors"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.NotEqualAny(firestore.FieldOf("author"), []string{"George Orwell", "F. Scott Fitzgerald"}).As("byExcludedAuthors"),
	)).
	Execute(ctx)pipeline_snippets_array.go

МАКСИМУМ

Синтаксис:

maximum(x: ANY...) -> ANY
maximum(x: ARRAY) -> ANY

Описание.

Возвращает максимальное значение в наборе x, не равное NULL и ABSENT.

Если в диапазоне нет значений, отличных от NULL и ABSENT, возвращается NULL.

Примеры

`x`	`y`	`maximum(x, y)`
`FALSE`	`TRUE`	`TRUE`
`FALSE`	-10L	-10L
0.0	-5L	0.0
"foo"	"bar"	"foo"
"foo"	["foo"]	["foo"]
`ABSENT`	`ABSENT`	`NULL`
`NULL`	`NULL`	`NULL`

Node.js

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("price").maximum().as("maximumPrice"))
);test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("price").maximum().as("maximumPrice"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("rating").logicalMaximum([1]).as("flooredRating")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("rating").logicalMaximum(1).alias("flooredRating")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("rating").logicalMaximum(1).alias("flooredRating")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").logical_maximum(1).as_("flooredRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(logicalMaximum(field("rating"), 1).as("flooredRating"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.LogicalMaximum(firestore.FieldOf("rating"), 1).As("flooredRating"),
	)).
	Execute(ctx)pipeline_snippets_logical.go

МИНИМУМ

Синтаксис:

minimum(x: ANY...) -> ANY
minimum(x: ARRAY) -> ANY

Описание.

Возвращает минимальное значение в серии значений x, не равное NULL и ABSENT.

Если в диапазоне нет значений, отличных от NULL и ABSENT, возвращается NULL.

Примеры

`x`	`y`	`minimum(x, y)`
`FALSE`	`TRUE`	`FALSE`
`FALSE`	-10L	`FALSE`
0.0	-5L	-5L
"foo"	"bar"	"bar"
"foo"	["foo"]	"foo"
`ABSENT`	`ABSENT`	`NULL`
`NULL`	`NULL`	`NULL`

Node.js

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("price").minimum().as("minimumPrice"))
);test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("price").minimum().as("minimumPrice"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("rating").logicalMinimum([5]).as("cappedRating")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("rating").logicalMinimum(5).alias("cappedRating")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("rating").logicalMinimum(5).alias("cappedRating")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("rating").logical_minimum(5).as_("cappedRating"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(logicalMinimum(field("rating"), 5).as("cappedRating"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.LogicalMinimum(firestore.FieldOf("rating"), 5).As("cappedRating"),
	)).
	Execute(ctx)pipeline_snippets_logical.go

Функции карт

Имя	Описание
`MAP`	Создает значение карты из серии пар "ключ-значение"
`MAP_GET`	Возвращает значение на карте по заданному ключу.
`MAP_SET`	Возвращает копию карты с набором обновленных ключей.
`MAP_REMOVE`	Возвращает копию карты с удаленной серией ключей.
`MAP_MERGE`	Объединяет несколько карт.
`CURRENT_CONTEXT`	Возвращает текущий контекст в виде карты.
`MAP_KEYS`	Возвращает массив всех ключей в карте.
`MAP_VALUES`	Возвращает массив всех значений на карте.
`MAP_ENTRIES`	Возвращает массив пар "ключ-значение" карты.

КАРТА

Синтаксис:

map(key: STRING, value: ANY, ...) -> MAP

Описание.

Создает карту из набора пар "ключ-значение".

MAP_GET

Синтаксис:

map_get(map: ANY, key: STRING) -> ANY

Описание.

Возвращает значение на карте по указанному ключу. Возвращает значение ABSENT, если key не существует в структуре или если аргумент map не является MAP.

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("awards").mapGet("pulitzer").as("hasPulitzerAward")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("awards").mapGet("pulitzer").as("hasPulitzerAward")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("awards").mapGet("pulitzer").as("hasPulitzerAward")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("awards").mapGet("pulitzer").alias("hasPulitzerAward")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("awards").mapGet("pulitzer").alias("hasPulitzerAward")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("awards").map_get("pulitzer").as_("hasPulitzerAward"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(mapGet(field("awards"), "pulitzer").as("hasPulitzerAward"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.MapGet(firestore.FieldOf("awards"), "pulitzer").As("hasPulitzerAward"),
	)).
	Execute(ctx)pipeline_snippets_object.go

MAP_SET

Синтаксис:

map_set(map: MAP, key: STRING, value: ANY, ...) -> MAP

Описание.

Возвращает копию значения map с содержимым, обновленным набором пар "ключ-значение".

Если заданное значение разрешается в отсутствующее значение, связанный ключ удаляется из карты.

Если аргумент map не является MAP, возвращает отсутствующее значение.

MAP_REMOVE

Синтаксис:

map_remove(map: MAP, key: STRING...) -> MAP

Описание.

Возвращает копию значения map с удаленными ключами.

MAP_MERGE

Синтаксис:

map_merge(maps: MAP...) -> MAP

Объединяет содержимое двух или более карт. Если несколько карт содержат конфликтующие значения, используется последнее значение.

CURRENT_CONTEXT

Синтаксис:

current_context() -> MAP

Возвращает карту, состоящую из всех доступных полей в текущей точке выполнения.

MAP_KEYS

Синтаксис:

map_keys(map: MAP) -> ARRAY<STRING>

Описание.

Возвращает массив, содержащий все ключи значения map.

MAP_VALUES

Синтаксис:

map_values(map: MAP) -> ARRAY<ANY>

Описание.

Возвращает массив, содержащий все значения map.

MAP_ENTRIES

Синтаксис:

map_entries(map: MAP) -> ARRAY<MAP>

Описание.

Возвращает массив, содержащий все пары "ключ-значение" в значении map.

Каждая пара "ключ-значение" будет представлена в виде карты с двумя записями: k и v.

Примеры

`map`	`map_entries(map)`
{}	[]
{"foo" : 2L}	[{"k": "foo", "v" : 2L}]
{"foo" : "bar", "bar" : "foo"}	[{"k": "foo", "v" : "bar" }, {"k" : "bar", "v": "foo"}]

Строковые функции

Имя	Описание
`BYTE_LENGTH`	Возвращает количество `BYTES` в значении `STRING` или `BYTES`.
`CHAR_LENGTH`	Возвращает количество символов Юникода в значении `STRING`.
`STARTS_WITH`	Возвращает `TRUE`, если `STRING` начинается с заданного префикса.
`ENDS_WITH`	Возвращает `TRUE`, если `STRING` заканчивается заданным постфиксом.
`LIKE`	Возвращает `TRUE`, если `STRING` соответствует шаблону.
`REGEX_CONTAINS`	Возвращает `TRUE`, если значение частично или полностью соответствует регулярному выражению.
`REGEX_MATCH`	Возвращает `TRUE`, если какая-либо часть значения соответствует регулярному выражению.
`STRING_CONCAT`	Объединяет несколько значений `STRING` в одно значение `STRING`.
`STRING_CONTAINS`	Возвращает `TRUE`, если значение содержит `STRING`.
`STRING_INDEX_OF`	Возвращает индекс первого вхождения значения `STRING` или `BYTES` (с точкой отсчета в нуле).
`TO_UPPER`	Преобразует значение `STRING` или `BYTES` в верхний регистр.
`TO_LOWER`	Преобразует значение `STRING` или `BYTES` в нижний регистр.
`SUBSTRING`	Возвращает подстроку значения `STRING` или `BYTES`.
`STRING_REVERSE`	Меняет значение `STRING` или `BYTES` на противоположное.
`STRING_REPEAT`	Повторяет значение `STRING` или `BYTES` указанное количество раз.
`STRING_REPLACE_ALL`	Заменяет все вхождения значения `STRING` или `BYTES`.
`STRING_REPLACE_ONE`	Заменяет первое вхождение значения `STRING` или `BYTES`.
`TRIM`	Удаляет начальные и конечные символы из значения `STRING` или `BYTES`.
`LTRIM`	Удаляет начальные символы из значения `STRING` или `BYTES`.
`RTRIM`	Удаляет конечные символы из значения `STRING` или `BYTES`.
`SPLIT`	Разделяет значение `STRING` или `BYTES` на массив.

BYTE_LENGTH

Синтаксис:

byte_length[T <: STRING | BYTES](value: T) -> INT64

Описание.

Возвращает количество BYTES в значении STRING или BYTES.

Примеры

value	`byte_length(value)`
"abc"	3
"xyzabc"	6
b"abc"	3

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("title").byteLength().as("titleByteLength")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("title").byteLength().as("titleByteLength")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("title").byteLength().as("titleByteLength")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("title").byteLength().alias("titleByteLength")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("title").byteLength().alias("titleByteLength")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("title").byte_length().as_("titleByteLength"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(byteLength(field("title")).as("titleByteLength"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.ByteLength(firestore.FieldOf("title")).As("titleByteLength"),
	)).
	Execute(ctx)pipeline_snippets_string.go

CHAR_LENGTH

Синтаксис:

char_length(value: STRING) -> INT64

Описание.

Возвращает количество кодовых точек Юникода в значении STRING.

Примеры

value	`char_length(value)`
"abc"	3
"Привет"	5
"мир"	5

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("title").charLength().as("titleCharLength")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("title").charLength().as("titleCharLength")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("title").charLength().as("titleCharLength")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("title").charLength().alias("titleCharLength")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("title").charLength().alias("titleCharLength")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("title").char_length().as_("titleCharLength"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(charLength(field("title")).as("titleCharLength"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.CharLength(firestore.FieldOf("title")).As("titleCharLength"),
	)).
	Execute(ctx)pipeline_snippets_string.go

STARTS_WITH

Синтаксис:

starts_with(value: STRING, prefix: STRING) -> BOOLEAN

Описание.

Возвращает TRUE, если value начинается с prefix.

Примеры

value	префикс	`starts_with(value, prefix)`
"abc"	"a"	true
"abc"	"b"	false
"abc"	""	true

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("title").startsWith("The")
      .as("needsSpecialAlphabeticalSort")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("title").startsWith("The")
      .as("needsSpecialAlphabeticalSort")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("title").startsWith("The")
      .as("needsSpecialAlphabeticalSort")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("title").startsWith("The")
            .alias("needsSpecialAlphabeticalSort")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("title").startsWith("The")
            .alias("needsSpecialAlphabeticalSort")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("title").starts_with("The").as_("needsSpecialAlphabeticalSort")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(startsWith(field("title"), "The").as("needsSpecialAlphabeticalSort"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.StartsWith(firestore.FieldOf("title"), "The").As("needsSpecialAlphabeticalSort"),
	)).
	Execute(ctx)pipeline_snippets_string.go

ENDS_WITH

Синтаксис:

ends_with(value: STRING, postfix: STRING) -> BOOLEAN

Описание.

Возвращает TRUE, если value заканчивается на postfix.

Примеры

value	постфикс	`ends_with(value, postfix)`
"abc"	"c"	true
"abc"	"b"	false
"abc"	""	true

Node.js

const result = await db.pipeline()
  .collection("inventory/devices/laptops")
  .select(
    field("name").endsWith("16 inch")
      .as("16InLaptops")
  )
  .execute();test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("inventory/devices/laptops")
  .select([
    Field("name").endsWith("16 inch")
      .as("16InLaptops")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("inventory/devices/laptops")
    .select(
        field("name").endsWith("16 inch")
            .alias("16InLaptops")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("inventory/devices/laptops")
    .select(
        field("name").endsWith("16 inch")
            .alias("16InLaptops")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("inventory/devices/laptops")
    .select(Field.of("name").ends_with("16 inch").as_("16InLaptops"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("inventory/devices/laptops")
        .select(endsWith(field("name"), "16 inch").as("16InLaptops"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("inventory/devices/laptops").
	Select(firestore.Fields(
		firestore.EndsWith(firestore.FieldOf("name"), "16 inch").As("`Laptops16in`"),
	)).
	Execute(ctx)pipeline_snippets_string.go

НРАВИТСЯ

Синтаксис:

like(value: STRING, pattern: STRING) -> BOOLEAN

Описание.

Возвращает TRUE, если value соответствует pattern.

Примеры

value	узор	`like(value, pattern)`
"Firestore"	"Fire%"	true
"Firestore"	"%store"	true
"Datastore"	"Data_tore"	true
"100%"	"100\%"	true

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("genre").like("%Fiction")
      .as("anyFiction")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("genre").like("%Fiction")
      .as("anyFiction")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("genre").like("%Fiction")
      .as("anyFiction")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("genre").like("%Fiction")
            .alias("anyFiction")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("genre").like("%Fiction")
            .alias("anyFiction")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("genre").like("%Fiction").as_("anyFiction"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(like(field("genre"), "%Fiction").as("anyFiction"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Like(firestore.FieldOf("genre"), "%Fiction").As("anyFiction"),
	)).
	Execute(ctx)pipeline_snippets_string.go

REGEX_CONTAINS

Синтаксис:

regex_contains(value: STRING, pattern: STRING) -> BOOLEAN

Описание.

Возвращает TRUE, если какая-либо часть value соответствует pattern. Если pattern не является допустимым регулярным выражением, функция возвращает error.

Регулярные выражения соответствуют синтаксису библиотеки re2.

Примеры

value	узор	`regex_contains(value, pattern)`
"Firestore"	"Огонь"	true
"Firestore"	"store$"	true
"Firestore"	"data"	false

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("title").regexContains("Firestore (Enterprise|Standard)")
      .as("isFirestoreRelated")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("title").regexContains("Firestore (Enterprise|Standard)")
      .as("isFirestoreRelated")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("title").regexContains("Firestore (Enterprise|Standard)")
      .as("isFirestoreRelated")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("title").regexContains("Firestore (Enterprise|Standard)")
            .alias("isFirestoreRelated")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("title").regexContains("Firestore (Enterprise|Standard)")
            .alias("isFirestoreRelated")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("title")
        .regex_contains("Firestore (Enterprise|Standard)")
        .as_("isFirestoreRelated")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(
            regexContains(field("title"), "Firestore (Enterprise|Standard)")
                .as("isFirestoreRelated"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("documents").
	Select(firestore.Fields(
		firestore.RegexContains(firestore.FieldOf("title"), "Firestore (Enterprise|Standard)").As("isFirestoreRelated"),
	)).
	Execute(ctx)pipeline_snippets_string.go

REGEX_MATCH

Синтаксис:

regex_match(value: STRING, pattern: STRING) -> BOOLEAN

Описание.

Возвращает TRUE, если value полностью соответствует pattern. Если pattern не является допустимым регулярным выражением, функция возвращает error.

Регулярные выражения соответствуют синтаксису библиотеки re2.

Примеры

value	узор	`regex_match(value, pattern)`
"Firestore"	"F.*store"	true
"Firestore"	"Огонь"	false
"Firestore"	"^F.*e$"	true

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("title").regexMatch("Firestore (Enterprise|Standard)")
      .as("isFirestoreExactly")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("title").regexMatch("Firestore (Enterprise|Standard)")
      .as("isFirestoreExactly")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("title").regexMatch("Firestore (Enterprise|Standard)")
      .as("isFirestoreExactly")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("title").regexMatch("Firestore (Enterprise|Standard)")
            .alias("isFirestoreExactly")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("title").regexMatch("Firestore (Enterprise|Standard)")
            .alias("isFirestoreExactly")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("title")
        .regex_match("Firestore (Enterprise|Standard)")
        .as_("isFirestoreExactly")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(
            regexMatch(field("title"), "Firestore (Enterprise|Standard)")
                .as("isFirestoreExactly"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("documents").
	Select(firestore.Fields(
		firestore.RegexMatch(firestore.FieldOf("title"), "Firestore (Enterprise|Standard)").As("isFirestoreExactly"),
	)).
	Execute(ctx)pipeline_snippets_string.go

STRING_CONCAT

Синтаксис:

string_concat(values: STRING...) -> STRING

Описание.

Объединяет два или более значений STRING в один результат.

Примеры

аргументы	`string_concat(values...)`
`()`	ошибка
`("a")`	"a"
`("abc", "def")`	"abcdef"
`("a", "", "c")`	"ac"

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("title").stringConcat(" by ", field("author"))
      .as("fullyQualifiedTitle")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("title").stringConcat(" by ", field("author"))
      .as("fullyQualifiedTitle")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("title").concat([" by ", Field("author")])
      .as("fullyQualifiedTitle")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("title").concat(" by ", field("author"))
            .alias("fullyQualifiedTitle")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("title").concat(" by ", field("author"))
            .alias("fullyQualifiedTitle")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("title")
        .concat(" by ", Field.of("author"))
        .as_("fullyQualifiedTitle")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(stringConcat(field("title"), " by ", field("author")).as("fullyQualifiedTitle"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.StringConcat(firestore.FieldOf("title"), " by ", firestore.FieldOf("author")).As("fullyQualifiedTitle"),
	)).
	Execute(ctx)pipeline_snippets_string.go

STRING_CONTAINS

Синтаксис:

string_contains(value: STRING, substring: STRING) -> BOOLEAN

Описание.

Проверяет, содержит ли value строку substring.

Примеры

value	substring	`string_contains(value, substring)`
"abc"	"b"	true
"abc"	"d"	false
"abc"	""	true
"a.c"	"."	true
"☃☃☃"	"☃"	true

Node.js

const result = await db.pipeline()
  .collection("articles")
  .select(
    field("body").stringContains("Firestore")
      .as("isFirestoreRelated")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("articles")
  .select(
    field("body").stringContains("Firestore")
      .as("isFirestoreRelated")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("articles")
  .select([
    Field("body").stringContains("Firestore")
      .as("isFirestoreRelated")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("articles")
    .select(
        field("body").stringContains("Firestore")
            .alias("isFirestoreRelated")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("articles")
    .select(
        field("body").stringContains("Firestore")
            .alias("isFirestoreRelated")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("articles")
    .select(Field.of("body").string_contains("Firestore").as_("isFirestoreRelated"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("articles")
        .select(stringContains(field("body"), "Firestore").as("isFirestoreRelated"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("articles").
	Select(firestore.Fields(
		firestore.StringContains(firestore.FieldOf("body"), "Firestore").As("isFirestoreRelated"),
	)).
	Execute(ctx)pipeline_snippets_string.go

STRING_INDEX_OF

Синтаксис:

string_index_of[T <: STRING | BYTES](value: T, search: T) -> INT64

Описание.

Возвращает индекс первого вхождения search в value, начиная с 0.

Если search не найдено, возвращает -1.
Если value – значение STRING, результат измеряется в кодовых точках Unicode. Если это значение BYTES, оно измеряется в байтах.
Если search – это пустое значение STRING или BYTES, результатом будет 0.

Примеры

value	search	`string_index_of(value, search)`
"hello world"	"o"	4
"hello world"	"l"	2
"hello world"	"z"	-1
"банан"	"na"	2
"abc"	""	0
b"abc"	b"b"	1
"é"	"é"	0
b"é"	b"é"	0

TO_UPPER

Синтаксис:

to_upper[T <: STRING | BYTES](value: T) -> T

Описание.

Преобразует значение STRING или BYTES в верхний регистр.

Если байт или символ не соответствует букве в нижнем регистре в кодировке UTF-8, он передается без изменений.

Примеры

value	`to_upper(value)`
"abc"	"ABC"
"AbC"	"ABC"
b"abc"	b"ABC"
b"a1c"	b"A1C"

Node.js

const result = await db.pipeline()
  .collection("authors")
  .select(
    field("name").toUpper()
      .as("uppercaseName")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("authors")
  .select(
    field("name").toUpper()
      .as("uppercaseName")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("authors")
  .select([
    Field("name").toUpper()
      .as("uppercaseName")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("authors")
    .select(
        field("name").toUpper()
            .alias("uppercaseName")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("authors")
    .select(
        field("name").toUpper()
            .alias("uppercaseName")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("authors")
    .select(Field.of("name").to_upper().as_("uppercaseName"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("authors")
        .select(toUpper(field("name")).as("uppercaseName"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("authors").
	Select(firestore.Fields(
		firestore.ToUpper(firestore.FieldOf("name")).As("uppercaseName"),
	)).
	Execute(ctx)pipeline_snippets_string.go

TO_LOWER

Синтаксис:

to_lower[T <: STRING | BYTES](value: T) -> T

Описание.

Преобразует значение STRING или BYTES в нижний регистр.

Если байт или символ не соответствует букве верхнего регистра в кодировке UTF-8, он передается без изменений.

Примеры

value	`to_lower(value)`
"ABC"	"abc"
"AbC"	"abc"
"A1C"	"a1c"
b"ABC"	b"abc"

Node.js

const result = await db.pipeline()
  .collection("authors")
  .select(
    field("genre").toLower().equal("fantasy")
      .as("isFantasy")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("authors")
  .select(
    field("genre").toLower().equal("fantasy")
      .as("isFantasy")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("authors")
  .select([
    Field("genre").toLower().equal("fantasy")
      .as("isFantasy")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("authors")
    .select(
        field("genre").toLower().equal("fantasy")
            .alias("isFantasy")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("authors")
    .select(
        field("genre").toLower().equal("fantasy")
            .alias("isFantasy")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("authors")
    .select(Field.of("genre").to_lower().equal("fantasy").as_("isFantasy"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("authors")
        .select(equal(toLower(field("genre")), "fantasy").as("isFantasy"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("authors").
	Select(firestore.Fields(
		firestore.Equal(firestore.ToLower(firestore.FieldOf("genre")), "fantasy").As("isFantasy"),
	)).
	Execute(ctx)pipeline_snippets_string.go

SUBSTRING

Синтаксис:

substring[T <: STRING | BYTES](input: T, position: INT64) -> T
substring[T <: STRING | BYTES](input: T, position: INT64, length: INT64) -> T

Описание.

Возвращает подстроку input, которая начинается с position (индекс с точкой отсчета в нуле) и включает до length записей. Если значение length не указано, возвращается подстрока от position до конца input.

Если input – значение STRING, то position и length измеряются в кодовых точках Unicode. Если это значение BYTES, оно измеряется в байтах.
Если значение position больше длины input, возвращается пустая подстрока. Если сумма position и length больше длины input, подстрока усекается до конца input.
Если значение position отрицательное, позиция отсчитывается от конца входных данных. Если отрицательное значение position больше размера входных данных, позиция устанавливается равной нулю. Значение length должно быть неотрицательным.

Примеры

Если параметр length не указан:

ввод	position	`substring(input, position)`
"abc"	0	"abc"
"abc"	1	"bc"
"abc"	3	""
"abc"	-1	"c"
b"abc"	1	b"bc"

Если указан параметр length:

ввод	position	длина	`substring(input, position, length)`
"abc"	0	1	"a"
"abc"	1	2	"bc"
"abc"	-1	1	"c"
b"abc"	0	1	b"a"

Node.js

const result = await db.pipeline()
  .collection("books")
  .where(field("title").startsWith("The "))
  .select(
    field("title").substring(4)
      .as("titleWithoutLeadingThe")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .where(field("title").startsWith("The "))
  .select(
    field("title").substring(4)
      .as("titleWithoutLeadingThe")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .where(Field("title").startsWith("The "))
  .select([
    Field("title").substring(position: 4)
      .as("titleWithoutLeadingThe")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .where(field("title").startsWith("The "))
    .select(
        field("title")
          .substring(constant(4),
            field("title").charLength().subtract(4))
            .alias("titleWithoutLeadingThe")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .where(field("title").startsWith("The "))
    .select(
        field("title").substring(
          constant(4),
            field("title").charLength().subtract(4))
            .alias("titleWithoutLeadingThe")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .where(Field.of("title").starts_with("The "))
    .select(Field.of("title").substring(4).as_("titleWithoutLeadingThe"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .where(startsWith(field("title"), "The "))
        .select(
            substring(field("title"), constant(4), field("title").charLength())
                .as("titleWithoutLeadingThe"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Where(firestore.StartsWith(firestore.FieldOf("title"), "The ")).
	Select(firestore.Fields(
		firestore.Substring(firestore.FieldOf("title"), firestore.ConstantOf(4), firestore.FieldOf("title").CharLength()).As("titleWithoutLeadingThe"),
	)).
	Execute(ctx)pipeline_snippets_string.go

STRING_REVERSE

Синтаксис:

string_reverse[T <: STRING | BYTES](input: T) -> T

Описание.

Возвращает входные данные в обратном порядке.

Если входные данные имеют тип STRING, символы определяются по кодовым точкам Unicode, а если BYTES – по байтам.

Примеры

ввод	`string_reverse(input)`
"abc"	"cba"
"a🌹b"	"b🌹a"
"Привет"	"olleh"
b"abc"	b"cba"

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("name").reverse().as("reversedName")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("name").reverse().as("reversedName")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("name").reverse().as("reversedName")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("name").reverse().alias("reversedName")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("name").reverse().alias("reversedName")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("name").string_reverse().as_("reversedName"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(reverse(field("name")).as("reversedName"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Reverse(firestore.FieldOf("name")).As("reversedName"),
	)).
	Execute(ctx)pipeline_snippets_string.go

STRING_REPEAT

Синтаксис:

string_repeat[T <: STRING | BYTES](input: T, repetitions: INT64) -> T

Описание.

Возвращает input, повторенное repetitions раз.

Значение параметра repetitions должно быть неотрицательным целым числом.
Если repetitions – это 0, возвращает пустое значение того же типа, что и input.
Если результат превышает максимально допустимый размер (1 МБ), возвращается ошибка.

Примеры

ввод	повторения	`string_repeat(input, repetitions)`
"foo"	3	"foofoofoo"
"foo"	0	""
"a "	3	"a a a "
b"ab"	2	b"abab"
"é🦆"	2	"é🦆é🦆"

STRING_REPLACE_ALL

Синтаксис:

string_replace_all[T <: STRING | BYTES](input: T, find: T, replacement: T) -> T

Описание.

Заменяет все неперекрывающиеся вхождения find в input на replacement.

Регистр учитывается.
Если параметр find пустой, замены не выполняются.

Примеры

ввод	найти	замена	`string_replace_all(input, find, replacement)`
"foobarfoo"	"foo"	"baz"	"bazbarbaz"
"ababab"	"aba"	"c"	"cbab"
"foobar"	"o"	""	"fbar"
"é🦆🌎🦆"	🦆	"a"	"éa🌎a"
b"abc"	b"b"	b"d"	b"adc"

STRING_REPLACE_ONE

Синтаксис:

string_replace_one[T <: STRING | BYTES](input: T, find: T, replacement: T) -> T

Описание.

Заменяет первое вхождение find в input на replacement.

Регистр учитывается.
Если параметр find пустой, замены не выполняются.

Примеры

ввод	найти	замена	`string_replace_one(input, find, replacement)`
"foobarfoo"	"foo"	"baz"	"bazbarfoo"
"é"	"é"	"a"	"a"
b"foobar"	b"o"	b"z"	b"fzoobar"

СЖПРОБЕЛЫ

Синтаксис:

trim[T <: STRING | BYTES](input: T, values_to_trim: T) -> T
trim[T <: STRING | BYTES](input: T) -> T

Описание.

Удаляет указанный набор BYTES или CHARS из начала и конца предоставленного значения input.

Если values_to_trim не указаны, удаляются пробелы.

Примеры

Если параметр values_to_trim не указан:

ввод	`trim(input)`
" foo "	"foo"
b" foo "	b"foo"
"foo"	"foo"
""	""
" "	""
"\t foo \n"	"foo"
b"\t foo \n"	b"foo"
"\r\f\v foo \r\f\v"	"foo"
b"\r\f\v foo \r\f\v"	b"foo"

Если указан параметр values_to_trim:

ввод	values_to_trim	`trim(input, values_to_trim)`
"abcbfooaacb"	"abc"	"foo"
"abcdaabadbac"	"abc"	"daabad"
b"C1C2C3"	b"C1"	b"C2C3"
b"C1C2"	"foo"	ошибка
"foo"	b"C1"	ошибка

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("name").trim().as("whitespaceTrimmedName")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("name").trim(" \n\t").as("whitespaceTrimmedName")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("name").trim().alias("whitespaceTrimmedName")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("name").trim().alias("whitespaceTrimmedName")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("name").trim().as_("whitespaceTrimmedName"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(trim(field("name")).as("whitespaceTrimmedName"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.Trim(firestore.FieldOf("name")).As("whitespaceTrimmedName"),
	)).
	Execute(ctx)pipeline_snippets_string.go

LTRIM

Синтаксис:

ltrim[T <: STRING | BYTES](value: T, to_trim: T) -> T
ltrim[T <: STRING | BYTES](value: T) -> T

Описание.

Удаляет указанный набор BYTES или CHARS из начала заданной value.

Если to_trim не указан, удаляет начальные пробелы.

Примеры

Если параметр to_trim не указан:

value	`ltrim(value)`
" foo "	"foo "
"foo"	"foo"

Если указан параметр to_trim:

value	to_trim	`ltrim(value, to_trim)`
"aaabc"	"a"	"bc"
"abacaba"	"ba"	"caba"
"é"	"é"	""

RTRIM

Синтаксис:

rtrim[T <: STRING | BYTES](value: T, to_trim: T) -> T
rtrim[T <: STRING | BYTES](value: T) -> T

Описание.

Удаляет указанный набор BYTES или CHARS из конца предоставленной value.

Если параметр to_trim не указан, удаляются конечные пробелы.

Примеры

Если параметр to_trim не указан:

value	`rtrim(value)`
" foo "	" foo"
"foo"	"foo"

Если указан параметр to_trim:

value	to_trim	`rtrim(value, to_trim)`
"abccc"	"c"	"ab"
"abacaba"	"ba"	"abac"
"é"	"é"	""

SPLIT

Синтаксис:

split(input: STRING) -> ARRAY<STRING>
split[T <: STRING | BYTES](input: T, delimiter: T) -> ARRAY<T>

Описание.

Разделяет значение STRING или BYTES с помощью разделителя.

Для STRING разделителем по умолчанию является запятая ,. Разделитель обрабатывается как одна строка.
Для BYTES необходимо указать разделитель.
Разделение по пустому разделителю создает массив кодовых точек Unicode для значений STRING и массив BYTES для значений BYTES.
При разделении пустой строки STRING возвращается массив ARRAY с одной пустой строкой STRING.

Примеры

Если параметр delimiter не указан:

ввод	`split(input)`
"foo,bar,foo"	["foo", "bar", "foo"]
"foo"	["foo"]
",foo,"	["", "foo", ""]
""	[""]
b"C120C2C4"	ошибка

Если указан параметр delimiter:

ввод	разделитель	`split(input, delimiter)`
"foo bar foo"	" "	["foo", "bar", "foo"]
"foo bar foo"	"z"	["foo bar foo"]
"abc"	""	["a", "b", "c"]
b"C1,C2,C4"	b","	[b"C1", b"C2", b"C4"]
b"ABC"	b""	[b"A", b"B", b"C"]
"foo"	b"C1"	ошибка

Функции временных меток

Имя	Описание
`CURRENT_TIMESTAMP`	Генерирует `TIMESTAMP`, соответствующий времени запроса.
`TIMESTAMP_TRUNC`	Усекает значение `TIMESTAMP` до заданной степени детализации.
`UNIX_MICROS_TO_TIMESTAMP`	Преобразует количество микросекунд, прошедших с `1970-01-01 00:00:00 UTC`, в `TIMESTAMP`.
`UNIX_MILLIS_TO_TIMESTAMP`	Преобразует количество миллисекунд, прошедших с `1970-01-01 00:00:00 UTC`, в `TIMESTAMP`.
`UNIX_SECONDS_TO_TIMESTAMP`	Преобразует количество секунд, прошедших с `1970-01-01 00:00:00 UTC`, в `TIMESTAMP`.
`TIMESTAMP_ADD`	Добавляет временной интервал к `TIMESTAMP`.
`TIMESTAMP_SUB`	Вычитает временной интервал из значения `TIMESTAMP`.
`TIMESTAMP_TO_UNIX_MICROS`	Преобразует `TIMESTAMP` в количество микросекунд, прошедших с `1970-01-01 00:00:00 UTC`.
`TIMESTAMP_TO_UNIX_MILLIS`	Преобразует `TIMESTAMP` в количество миллисекунд, прошедших с `1970-01-01 00:00:00 UTC`.
`TIMESTAMP_TO_UNIX_SECONDS`	Преобразует `TIMESTAMP` в количество секунд, прошедших с `1970-01-01 00:00:00 UTC`.
`TIMESTAMP_DIFF`	Возвращает целое число указанных интервалов `unit` между двумя значениями `TIMESTAMP`.
`TIMESTAMP_EXTRACT`	Извлекает определенную часть `part` (например, год, месяц, день) из значения `TIMESTAMP`.

CURRENT_TIMESTAMP

Синтаксис:

current_timestamp() -> TIMESTAMP

Описание.

Возвращает временную метку начала запроса input (интерпретируется как количество микросекунд с 1970-01-01 00:00:00 UTC).

Это значение стабильно в рамках запроса и всегда будет разрешаться в одно и то же значение при многократном вызове.

TIMESTAMP_TRUNC

Синтаксис:

timestamp_trunc(timestamp: TIMESTAMP, granularity: STRING[, timezone: STRING]) -> TIMESTAMP

Описание.

Усекает временную метку до заданной детализации.

Аргумент granularity должен быть строкой и иметь одно из следующих значений:

microsecond
millisecond
second
minute
hour
day
week
week([weekday])
month
quarter
year
isoyear

Если указан аргумент timezone, усечение будет выполняться на основе календарных границ заданного часового пояса (например, усечение до дня будет выполняться до полуночи в заданном часовом поясе). При усечении будет учитываться переход на летнее время.

Если timezone не указан, усечение будет выполняться на основе календарных границ UTC.

Аргумент timezone должен быть строковым представлением часового пояса из базы данных tz, например America/New_York. Вы также можете задать собственное смещение по времени, указав смещение от GMT.

Примеры

`timestamp`	`granularity`	`timezone`	`timestamp_trunc(timestamp, granularity, timezone)`
2000-01-01 10:20:30:123456 UTC	"second"	Не предусмотрено	2001-01-01 10:20:30 UTC
31.05.1997 04:30:30 UTC	"day"	Не предусмотрено	31 мая 1997 г., 00:00:00 UTC
31.05.1997 04:30:30 UTC	"day"	"America/Los_Angeles"	30 мая 1997 г., 07:00:00 UTC
16.03.2001 04:00:00 UTC	"week(friday)	Не предусмотрено	16.03.2001 00:00:00 UTC
23.03.2001 04:00:00 UTC	"week(friday)	"America/Los_Angeles"	23.03.2001 17:00:00 UTC
24 января 2026 г., 20:00:00 по всемирному координированному времени (UTC)	"month"	"GMT+06:32:43"	2026-01-01T06:32:43 UTC

UNIX_MICROS_TO_TIMESTAMP

Синтаксис:

unix_micros_to_timestamp(input: INT64) -> TIMESTAMP

Описание.

Преобразует input (интерпретируется как количество микросекунд с 1970-01-01 00:00:00 UTC) в TIMESTAMP. Возвращает error, если input не может быть преобразовано в допустимое значение TIMESTAMP.

Примеры

`input`	`unix_micros_to_timestamp(input)`
0 л	01.01.1970 00:00:00 UTC
400123456L	1970-01-01 00:06:40.123456 UTC
-1000000L	31.12.1969 23:59:59 UTC

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("createdAtMicros").unixMicrosToTimestamp().as("createdAtString")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("createdAtMicros").unixMicrosToTimestamp().as("createdAtString")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("createdAtMicros").unixMicrosToTimestamp().as("createdAtString")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtMicros").unixMicrosToTimestamp().alias("createdAtString")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtMicros").unixMicrosToTimestamp().alias("createdAtString")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("createdAtMicros")
        .unix_micros_to_timestamp()
        .as_("createdAtString")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(unixMicrosToTimestamp(field("createdAtMicros")).as("createdAtString"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("documents").
	Select(firestore.Fields(
		firestore.UnixMicrosToTimestamp(firestore.FieldOf("createdAtMicros")).As("createdAtString"),
	)).
	Execute(ctx)pipeline_snippets_date_timestamp.go

UNIX_MILLIS_TO_TIMESTAMP

Синтаксис:

unix_millis_to_timestamp(input: INT64) -> TIMESTAMP

Описание.

Преобразует input (интерпретируется как количество миллисекунд с 1970-01-01 00:00:00 UTC) в TIMESTAMP. Возвращает error, если input не может быть преобразовано в допустимое значение TIMESTAMP.

Примеры

`input`	`unix_millis_to_timestamp(input)`
0 л	01.01.1970 00:00:00 UTC
4000123L	1970-01-01 01:06:40.123 UTC
-1000000L	31.12.1969 23:43:20 UTC

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("createdAtMillis").unixMillisToTimestamp().as("createdAtString")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("createdAtMillis").unixMillisToTimestamp().as("createdAtString")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("createdAtMillis").unixMillisToTimestamp().as("createdAtString")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtMillis").unixMillisToTimestamp().alias("createdAtString")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtMillis").unixMillisToTimestamp().alias("createdAtString")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("createdAtMillis")
        .unix_millis_to_timestamp()
        .as_("createdAtString")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(unixMillisToTimestamp(field("createdAtMillis")).as("createdAtString"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("documents").
	Select(firestore.Fields(
		firestore.UnixMillisToTimestamp(firestore.FieldOf("createdAtMillis")).As("createdAtString"),
	)).
	Execute(ctx)pipeline_snippets_date_timestamp.go

UNIX_SECONDS_TO_TIMESTAMP

Синтаксис:

unix_seconds_to_timestamp(input: INT64) -> TIMESTAMP

Описание.

Преобразует input (интерпретируется как количество секунд с 1970-01-01 00:00:00 UTC) в TIMESTAMP. Возвращает error, если input не может быть преобразовано в допустимое значение TIMESTAMP.

Примеры

`input`	`unix_seconds_to_timestamp(input)`
0 л	01.01.1970 00:00:00 UTC
60 л	1970-01-01 00:01:00 UTC
-300L	31.12.1969 23:55:00 UTC

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("createdAtSeconds").unixSecondsToTimestamp().as("createdAtString")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("createdAtSeconds").unixSecondsToTimestamp().as("createdAtString")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("createdAtSeconds").unixSecondsToTimestamp().as("createdAtString")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtSeconds").unixSecondsToTimestamp().alias("createdAtString")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtSeconds").unixSecondsToTimestamp().alias("createdAtString")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("createdAtSeconds")
        .unix_seconds_to_timestamp()
        .as_("createdAtString")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(unixSecondsToTimestamp(field("createdAtSeconds")).as("createdAtString"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("documents").
	Select(firestore.Fields(
		firestore.UnixSecondsToTimestamp(firestore.FieldOf("createdAtSeconds")).As("createdAtString"),
	)).
	Execute(ctx)pipeline_snippets_date_timestamp.go

TIMESTAMP_ADD

Синтаксис:

timestamp_add(timestamp: TIMESTAMP, unit: STRING, amount: INT64) -> TIMESTAMP

Описание.

Добавляет amount unit из timestamp. Аргумент amount может быть отрицательным. В этом случае он эквивалентен TIMESTAMP_SUB.

Аргумент unit должен быть строкой и иметь одно из следующих значений:

microsecond
millisecond
second
minute
hour
day

Если полученная временная метка не укладывается в диапазон TIMESTAMP, выдается ошибка.

Примеры

`timestamp`	`unit`	`amount`	`timestamp_add(timestamp, unit, amount)`
20.02.2025 00:00:00 UTC	"minute"	2L	20.02.2025 00:02:00 UTC
20.02.2025 00:00:00 UTC	"час"	-4L	19.02.2025 20:00:00 UTC
20.02.2025 00:00:00 UTC	"day"	5L	25.02.2025 00:00:00 UTC

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("createdAt").timestampAdd("day", 3653).as("expiresAt")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("createdAt").timestampAdd("day", 3653).as("expiresAt")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("createdAt").timestampAdd(3653, .day).as("expiresAt")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAt")
          .timestampAdd("day", 3653)
          .alias("expiresAt")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAt").timestampAdd("day", 3653).alias("expiresAt")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(Field.of("createdAt").timestamp_add("day", 3653).as_("expiresAt"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(timestampAdd(field("createdAt"), "day", 3653).as("expiresAt"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("documents").
	Select(firestore.Fields(
		firestore.TimestampAdd(firestore.FieldOf("createdAt"), "day", 3653).As("expiresAt"),
	)).
	Execute(ctx)pipeline_snippets_date_timestamp.go

TIMESTAMP_SUB

Синтаксис:

timestamp_sub(timestamp: TIMESTAMP, unit: STRING, amount: INT64) -> TIMESTAMP

Описание.

Вычитает amount unit из timestamp. Аргумент amount может быть отрицательным. В этом случае он эквивалентен TIMESTAMP_ADD.

Аргумент unit должен быть строкой и иметь одно из следующих значений:

microsecond
millisecond
second
minute
hour
day

Если полученная временная метка не укладывается в диапазон TIMESTAMP, выдается ошибка.

Примеры

`timestamp`	`unit`	`amount`	`timestamp_sub(timestamp, unit, amount)`
4 июля 2026 г., 00:00:00 UTC	"minute"	40L	03.07.2026 23:20:00 UTC
4 июля 2026 г., 00:00:00 UTC	"час"	-24L	5 июля 2026 г., 00:00:00 UTC
4 июля 2026 г., 00:00:00 UTC	"day"	3L	01.07.2026 00:00:00 UTC

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("expiresAt").timestampSubtract("day", 14).as("sendWarningTimestamp")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("expiresAt").timestampSubtract("day", 14).as("sendWarningTimestamp")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("expiresAt").timestampSubtract(14, .day).as("sendWarningTimestamp")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("expiresAt")
          .timestampSubtract("day", 14)
          .alias("sendWarningTimestamp")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("expiresAt").timestampSubtract("day", 14).alias("sendWarningTimestamp")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("expiresAt")
        .timestamp_subtract("day", 14)
        .as_("sendWarningTimestamp")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(timestampSubtract(field("expiresAt"), "day", 14).as("sendWarningTimestamp"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("documents").
	Select(firestore.Fields(
		firestore.TimestampSubtract(firestore.FieldOf("expiresAt"), "day", 14).As("sendWarningTimestamp"),
	)).
	Execute(ctx)pipeline_snippets_date_timestamp.go

TIMESTAMP_TO_UNIX_MICROS

Синтаксис:

timestamp_to_unix_micros(input: TIMESTAMP) -> INT64

Описание.

Преобразует input в количество микросекунд, прошедших с 1970-01-01 00:00:00 UTC. Усекает более высокие уровни точности, округляя значение до начала микросекунды.

Примеры

`input`	`timestamp_to_unix_micros(input)`
01.01.1970 00:00:00 UTC	0 л
1970-01-01 00:06:40.123456 UTC	400123456L
31.12.1969 23:59:59 UTC	-1000000L

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("dateString").timestampToUnixMicros().as("unixMicros")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("dateString").timestampToUnixMicros().as("unixMicros")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("dateString").timestampToUnixMicros().as("unixMicros")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixMicros().alias("unixMicros")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixMicros().alias("unixMicros")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(Field.of("dateString").timestamp_to_unix_micros().as_("unixMicros"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(timestampToUnixMicros(field("dateString")).as("unixMicros"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("documents").
	Select(firestore.Fields(
		firestore.TimestampToUnixMicros(firestore.FieldOf("dateString")).As("unixMicros"),
	)).
	Execute(ctx)pipeline_snippets_date_timestamp.go

TIMESTAMP_TO_UNIX_MILLIS

Синтаксис:

timestamp_to_unix_millis(input: TIMESTAMP) -> INT64

Описание.

Преобразует input в количество миллисекунд, прошедших с 1970-01-01 00:00:00 UTC. Округляет значение до миллисекунд.

Примеры

`input`	`timestamp_to_unix_millis(input)`
01.01.1970 00:00:00 UTC	0 л
1970-01-01 01:06:40.123 UTC	4000123L
1969-12-31 23:43:20	-1000000L

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("dateString").timestampToUnixMillis().as("unixMillis")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("dateString").timestampToUnixMillis().as("unixMillis")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("dateString").timestampToUnixMillis().as("unixMillis")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixMillis().alias("unixMillis")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixMillis().alias("unixMillis")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(Field.of("dateString").timestamp_to_unix_millis().as_("unixMillis"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(timestampToUnixMillis(field("dateString")).as("unixMillis"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("documents").
	Select(firestore.Fields(
		firestore.TimestampToUnixMillis(firestore.FieldOf("dateString")).As("unixMillis"),
	)).
	Execute(ctx)pipeline_snippets_date_timestamp.go

TIMESTAMP_TO_UNIX_SECONDS

Синтаксис:

timestamp_to_unix_seconds(input: TIMESTAMP) -> INT64

Описание.

Преобразует input в количество секунд, прошедших с 1970-01-01 00:00:00 UTC. Усекает более высокие уровни точности, округляя до начала секунды.

Примеры

`input`	`timestamp_to_unix_seconds(input)`
01.01.1970 00:00:00 UTC	0 л
1970-01-01 00:01:00 UTC	60 л
31.12.1969 23:55:00 UTC	-300L

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("dateString").timestampToUnixSeconds().as("unixSeconds")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("dateString").timestampToUnixSeconds().as("unixSeconds")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("dateString").timestampToUnixSeconds().as("unixSeconds")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixSeconds().alias("unixSeconds")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixSeconds().alias("unixSeconds")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(Field.of("dateString").timestamp_to_unix_seconds().as_("unixSeconds"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(timestampToUnixSeconds(field("dateString")).as("unixSeconds"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("documents").
	Select(firestore.Fields(
		firestore.TimestampToUnixSeconds(firestore.FieldOf("dateString")).As("unixSeconds"),
	)).
	Execute(ctx)pipeline_snippets_date_timestamp.go

TIMESTAMP_DIFF

Синтаксис:

timestamp_diff(end: TIMESTAMP, start: TIMESTAMP, unit: STRING) -> INT64

Описание.

Возвращает целое число указанных интервалов (unit) между двумя датами (TIMESTAMP).

Возвращает отрицательное значение, если end предшествует start.
Усекает дробную часть. Например, timestamp_diff("2021-01-01 00:00:01", "2021-01-01 00:00:00", "minute") возвращает 0.

Аргумент unit должен быть строкой и иметь одно из следующих значений:

microsecond
millisecond
second
minute
hour
day

Примеры

`end`	`start`	`unit`	`timestamp_diff(end, start, unit)`
2026-07-04 00:01:00 UTC	4 июля 2026 г., 00:00:00 UTC	"second"	60 л
4 июля 2026 г., 00:00:00 UTC	5 июля 2026 г., 00:00:00 UTC	"day"	-1L
04.07.2026 00:00:59 UTC	4 июля 2026 г., 00:00:00 UTC	"minute"	0 л

TIMESTAMP_EXTRACT

Синтаксис:

timestamp_extract(timestamp: TIMESTAMP, part: STRING[, timezone: STRING]) -> INT64

Описание.

Извлекает определенную часть part (например, год, месяц, день) из timestamp.

Аргумент part должен быть строкой и иметь одно из следующих значений:

microsecond
millisecond
second
minute
hour
day
dayofweek – возвращает значение от 1 (воскресенье) до 7 (суббота).
dayofyear
week – возвращает номер недели в году, начиная с 1 для первого воскресенья года.
week([weekday]): возвращает номер недели в году, начиная с указанного дня недели weekday.
month
quarter
year
isoweek – возвращает номер недели по стандарту ISO 8601.
isoyear: возвращает год по стандарту ISO 8601.

Если указан аргумент timezone, извлечение будет основано на календаре заданного часового пояса. При извлечении будет учитываться переход на летнее время.

Если не указать timezone, извлечение будет основано на UTC.

Аргумент timezone должен быть строковым представлением часового пояса из базы данных часовых поясов, например America/New_York. Вы также можете задать собственное смещение по времени, указав смещение от GMT.

Примеры

`timestamp`	`part`	`timezone`	`timestamp_extract(timestamp, part, timezone)`
20.02.2025 10:20:30 UTC	"year"	Не предусмотрено	2025 г.
20.02.2025 10:20:30 UTC	"day"	Не предусмотрено	20
31.12.2025 23:59:59 UTC	"year"	"Asia/Tokyo"	2026

Функции типов

Имя	Описание
`TYPE`	Возвращает тип значения в виде `STRING`.
`IS_TYPE`	Возвращает `true`, если значение соответствует указанному типу.

ТИП

Синтаксис:

type(input: ANY) -> STRING

Описание.

Возвращает строковое представление типа input.

Если значение отсутствует, возвращает NULL.

Примеры

`input`	`type(input)`
NULL	"null"
true	"boolean"
1	"int32"
-3L	"int64"
3.14	"float64"
2024-01-01T00:00:00Z UTC	"timestamp"
"foo"	"string"
b"foo"	"bytes"
[1, 2]	"array"
{"a": 1}	"map"
`path("c/d")`	"reference"
`vector([1.0, 2.0])`	"vector"
ABSENT	NULL

Примеры клиентов

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("title").notEqual("1984").as("not1984"))
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("title").notEqual("1984").as("not1984"))
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("title").notEqual("1984").as("not1984")])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("title").notEqual("1984").alias("not1984"))
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("title").notEqual("1984").alias("not1984"))
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("title").not_equal("1984").as_("not1984"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(notEqual(field("title"), "1984").as("not1984"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.NotEqual(firestore.FieldOf("title"), "1984").As("not1984"),
	)).
	Execute(ctx)pipeline_snippets_comparison.go

IS_TYPE

Синтаксис:

is_type(input: ANY, type: STRING) -> BOOLEAN

Описание.

Возвращает true, если input соответствует указанному type, в противном случае – false. Если input отсутствует, возвращает NULL.

Поддерживаются следующие строки type:

"null"
"boolean"
"int32"
"int64"
"float64"
"decimal128"
"number"
"timestamp"
"string"
"bytes"
"array"
"map"
"reference"
"vector"
"geo_point"
"max_key"
"min_key"
"object_id"
"regex"
"bson_timestamp"

Примеры

`input`	`type`	`is_type(input, type)`
NULL	"null"	true
true	"boolean"	true
3.14	"float64"	true
"foo"	"string"	true
b"foo"	"string"	false
[1, 2]	"array"	true
{"a": 1}	"map"	true
`vector([1.0, 2.0])`	"vector"	true
ABSENT	"string"	NULL
"bar"	"other"	ОШИБКА

Векторные функции

Имя	Описание
`COSINE_DISTANCE`	Возвращает косинусное расстояние между двумя векторами.
`DOT_PRODUCT`	Возвращает скалярное произведение двух векторов.
`EUCLIDEAN_DISTANCE`	Возвращает евклидово расстояние между двумя векторами.
`MANHATTAN_DISTANCE`	Возвращает манхэттенское расстояние между двумя векторами.
`VECTOR_LENGTH`	Возвращает количество элементов в векторе

COSINE_DISTANCE

Синтаксис:

cosine_distance(x: VECTOR, y: VECTOR) -> FLOAT64

Описание.

Возвращает косинусное расстояние между x и y.

Node.js

const sampleVector = [0.0, 1, 2, 3, 4, 5];
const result = await db.pipeline()
  .collection("books")
  .select(
    field("embedding").cosineDistance(sampleVector).as("cosineDistance")
  )
  .execute();test.firestore.js

Web

const sampleVector = [0.0, 1, 2, 3, 4, 5];
const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("embedding").cosineDistance(sampleVector).as("cosineDistance")));test.firestore.js

Swift

let sampleVector = [0.0, 1, 2, 3, 4, 5]
let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("embedding").cosineDistance(sampleVector).as("cosineDistance")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val sampleVector = doubleArrayOf(0.0, 1.0, 2.0, 3.0, 4.0, 5.0)
val result = db.pipeline()
    .collection("books")
    .select(
        field("embedding").cosineDistance(sampleVector).alias("cosineDistance")
    )
    .execute()DocSnippets.kt

Java

double[] sampleVector = {0.0, 1.0, 2.0, 3.0, 4.0, 5.0};
Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("embedding").cosineDistance(sampleVector).alias("cosineDistance")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field
from google.cloud.firestore_v1.vector import Vector

sample_vector = Vector([0.0, 1.0, 2.0, 3.0, 4.0, 5.0])
result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("embedding").cosine_distance(sample_vector).as_("cosineDistance")
    )
    .execute()
)firestore_pipelines.py

Java

double[] sampleVector = new double[] {0.0, 1.0, 2.0, 3.0, 4.0, 5.0};
Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(cosineDistance(field("embedding"), sampleVector).as("cosineDistance"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

sampleVector := []float64{0.0, 1.0, 2.0, 3.0, 4.0, 5.0}
snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.CosineDistance(firestore.FieldOf("embedding"), sampleVector).As("cosineDistance"),
	)).
	Execute(ctx)pipeline_snippets_vector.go

DOT_PRODUCT

Синтаксис:

dot_product(x: VECTOR, y: VECTOR) -> FLOAT64

Описание.

Возвращает скалярное произведение x и y.

Node.js

const sampleVector = [0.0, 1, 2, 3, 4, 5];
const result = await db.pipeline()
  .collection("books")
  .select(
    field("embedding").dotProduct(sampleVector).as("dotProduct")
  )
  .execute();test.firestore.js

Web

const sampleVector = [0.0, 1, 2, 3, 4, 5];
const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("embedding").dotProduct(sampleVector).as("dotProduct")
  )
);test.firestore.js

Swift

let sampleVector = [0.0, 1, 2, 3, 4, 5]
let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("embedding").dotProduct(sampleVector).as("dotProduct")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val sampleVector = doubleArrayOf(0.0, 1.0, 2.0, 3.0, 4.0, 5.0)
val result = db.pipeline()
    .collection("books")
    .select(
        field("embedding").dotProduct(sampleVector).alias("dotProduct")
    )
    .execute()DocSnippets.kt

Java

double[] sampleVector = {0.0, 1.0, 2.0, 3.0, 4.0, 5.0};
Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("embedding").dotProduct(sampleVector).alias("dotProduct")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field
from google.cloud.firestore_v1.vector import Vector

sample_vector = Vector([0.0, 1.0, 2.0, 3.0, 4.0, 5.0])
result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("embedding").dot_product(sample_vector).as_("dotProduct"))
    .execute()
)firestore_pipelines.py

Java

double[] sampleVector = new double[] {0.0, 1.0, 2.0, 3.0, 4.0, 5.0};
Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(dotProduct(field("embedding"), sampleVector).as("dotProduct"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

sampleVector := []float64{0.0, 1.0, 2.0, 3.0, 4.0, 5.0}
snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.DotProduct(firestore.FieldOf("embedding"), sampleVector).As("dotProduct"),
	)).
	Execute(ctx)pipeline_snippets_vector.go

EUCLIDEAN_DISTANCE

Синтаксис:

euclidean_distance(x: VECTOR, y: VECTOR) -> FLOAT64

Описание.

Вычисляет евклидово расстояние между x и y.

Node.js

const sampleVector = [0.0, 1, 2, 3, 4, 5];
const result = await db.pipeline()
  .collection("books")
  .select(
    field("embedding").euclideanDistance(sampleVector).as("euclideanDistance")
  )
  .execute();test.firestore.js

Web

const sampleVector = [0.0, 1, 2, 3, 4, 5];
const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("embedding").euclideanDistance(sampleVector).as("euclideanDistance")
  )
);test.firestore.js

Swift

let sampleVector = [0.0, 1, 2, 3, 4, 5]
let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("embedding").euclideanDistance(sampleVector).as("euclideanDistance")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val sampleVector = doubleArrayOf(0.0, 1.0, 2.0, 3.0, 4.0, 5.0)
val result = db.pipeline()
    .collection("books")
    .select(
        field("embedding").euclideanDistance(sampleVector).alias("euclideanDistance")
    )
    .execute()DocSnippets.kt

Java

double[] sampleVector = {0.0, 1.0, 2.0, 3.0, 4.0, 5.0};
Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("embedding").euclideanDistance(sampleVector).alias("euclideanDistance")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field
from google.cloud.firestore_v1.vector import Vector

sample_vector = Vector([0.0, 1.0, 2.0, 3.0, 4.0, 5.0])
result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("embedding")
        .euclidean_distance(sample_vector)
        .as_("euclideanDistance")
    )
    .execute()
)firestore_pipelines.py

Java

double[] sampleVector = new double[] {0.0, 1.0, 2.0, 3.0, 4.0, 5.0};
Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(euclideanDistance(field("embedding"), sampleVector).as("euclideanDistance"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

sampleVector := []float64{0.0, 1.0, 2.0, 3.0, 4.0, 5.0}
snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.EuclideanDistance(firestore.FieldOf("embedding"), sampleVector).As("euclideanDistance"),
	)).
	Execute(ctx)pipeline_snippets_vector.go

MANHATTAN_DISTANCE

Синтаксис:

manhattan_distance(x: VECTOR, y: VECTOR) -> FLOAT64

Описание.

Вычисляет манхэттенское расстояние между x и y.

VECTOR_LENGTH

Синтаксис:

vector_length(vector: VECTOR) -> INT64

Описание.

Возвращает количество элементов в VECTOR.

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("embedding").vectorLength().as("vectorLength")
  )
  .execute();test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("embedding").vectorLength().as("vectorLength")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("embedding").vectorLength().as("vectorLength")
  ])
  .execute()PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(
        field("embedding").vectorLength().alias("vectorLength")
    )
    .execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("embedding").vectorLength().alias("vectorLength")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("embedding").vector_length().as_("vectorLength"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(vectorLength(field("embedding")).as("vectorLength"))
        .execute()
        .get();PipelineSnippets.java

Проложить маршрут

snapshot := client.Pipeline().
	Collection("books").
	Select(firestore.Fields(
		firestore.VectorLength(firestore.FieldOf("embedding")).As("vectorLength"),
	)).
	Execute(ctx)pipeline_snippets_vector.go

Все функции Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Агрегирование

COUNT

Node.js

Web

Swift

Kotlin

Java

Python

Java

Проложить маршрут

COUNT_IF

Node.js

Web

Swift

Kotlin

Java

Python

Java

Проложить маршрут

COUNT_DISTINCT

Node.js

Web

Swift

Kotlin

Java

Python

Java

Проложить маршрут

SUM

Node.js

Web

Swift

Kotlin

Java

Python

Java

Проложить маршрут

СРЕДНЕЕ

Node.js

Web

Swift

Kotlin

Java

Python

Java

Проложить маршрут

МИНИМУМ

Node.js

Web

Swift

Kotlin

Java

Python

Java

Проложить маршрут

МАКСИМУМ

Node.js

Web

Swift

Kotlin

Java

Python

Java

Проложить маршрут

FIRST

ПОСЛЕДНИЙ

ARRAY_AGG

ARRAY_AGG_DISTINCT

Арифметические функции

ABS

ДОБАВИТЬ

Node.js

Web

Swift

Kotlin

Java

Python

Java

Проложить маршрут

Все функции