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

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

Имя Описание
ARRAY Возвращает ARRAY содержащий один элемент для каждого входного аргумента.
ARRAY_CONCAT Объединяет несколько массивов в один ARRAY
ARRAY_CONTAINS Возвращает TRUE если заданный ARRAY содержит определенное значение.
ARRAY_CONTAINS_ALL Возвращает TRUE если все значения присутствуют в ARRAY
ARRAY_CONTAINS_ANY Возвращает TRUE если хотя бы одно из значений присутствует в ARRAY
ARRAY_GET Возвращает элемент по заданному индексу в ARRAY
ARRAY_LENGTH Возвращает количество элементов в ARRAY
ARRAY_REVERSE Изменяет порядок элементов в ARRAY
SUM Возвращает сумму всех NUMERIC значений в ARRAY .
JOIN Создает конкатенацию элементов ARRAY в виде STRING значения.

МНОЖЕСТВО

Синтаксис:

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

Описание:

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

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

Примеры:

ценности array(values)
() []
(1, 2, 3) [1, 2, 3]
("а", 1, true) ["а", 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]

Web 

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("genre").arrayConcat([field("subGenre")]).as("allGenres"))
);
test.firestore.js
Быстрый 
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

ARRAY_CONTAINS

Синтаксис:

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

Описание:

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

Примеры:

множество ценить array_contains(array, value)
[1, 2, 3] 2 истинный
[[1, 2], [3]] [1, 2] истинный
[1, null] нулевой истинный
"abc" ЛЮБОЙ ошибка

Web 

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("genre").arrayContains(constant("mystery")).as("isMystery"))
);
test.firestore.js
Быстрый 
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

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] истинный
[1, 2, 3] [1, 4] ЛОЖЬ
[1, null] [нулевой] истинный
[NaN] [NaN] истинный
[] [] истинный
[1, 2, 3] [] истинный

Web 

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("genre")
      .arrayContainsAll([constant("fantasy"), constant("adventure")])
      .as("isFantasyAdventure")
  )
);
test.firestore.js
Быстрый 
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

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] истинный
[1, 2, 3] [4, 5] ЛОЖЬ
[1, 2, null] [нулевой] истинный

Web 

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("genre")
      .arrayContainsAny([constant("fantasy"), constant("nonfiction")])
      .as("isMysteryOrFantasy")
  )
);
test.firestore.js
Быстрый 
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

ARRAY_GET

Синтаксис: 

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

Описание:

Возвращает элемент array , index которого начинается с 0.

  • Если index отрицательный, доступ к элементам осуществляется с конца массива, где -1 — последний элемент.
  • Если array не является типом ARRAY , функция возвращает отсутствующее значение.
  • Если 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 отсутствующий
нулевой 0 отсутствующий
Array "а" ошибка
Array 2.0 ошибка

ДЛИНА МАССИВА

Синтаксис: 

array_length(array: ARRAY) -> INT64

Описание:

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

Примеры:

множество array_length(array)
[1, 2, 3] 3
[] 0
[1, 1, 1] 3
[1, null] 2

Web 

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("genre").arrayLength().as("genreCount"))
);
test.firestore.js
Быстрый 
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

ARRAY_REVERSE

Синтаксис: 

array_reverse(array: ARRAY) -> ARRAY

Описание:

Переворачивает заданный array .

Примеры:

множество array_reverse(array)
[1, 2, 3] [3, 2, 1]
["а", "б"] ["б", "а"]
[1, 2, 2, 3] [3, 2, 2, 1]

Web 

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("genre").arrayReverse().as("reversedGenres"))
);
test.firestore.js
Быстрый 
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

СУММА

Синтаксис: 

sum(array: ARRAY) -> INT64 | FLOAT64

Описание:

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

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

Примеры:

множество sum(array)
[1, 2, 3] 6 л
[1 л, 2 л, 3 л] 6 л
[2000000000, 2000000000] 4000000000 л
[10, 20.5] 30.5
[1, "а", 2] 3 л
[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"] "," "а,с"
[b'a', b'b', b'c'] б',' б'а,б,с'
["а", б'с'] "," ошибка
["а", "с"] б',' ошибка
[b'a', b'c'] "," ошибка

Если предоставлен null_text :

множество разделитель нулевой текст join(array, delimiter, null_text)
["a", null, "c"] "," "ОТСУТСТВУЮЩИЙ" "a,MISSING,c"
[b'a', null, b'c'] б',' b'NULL' b'a,NULL,c'
[null, "b", null] "," "ОТСУТСТВУЮЩИЙ" "ПРОПАВШИЙ,b,ПРОПАВШИЙ"
[b'a', null, null] б',' b'NULL' b'a,NULL,NULL'
["a", null] "," б'Н' ошибка
[b'a', null] б',' "Н" ошибка