A edição Enterprise do Cloud Firestore com compatibilidade com o MongoDB já está disponível. Saiba mais.

Funções de matriz

Nome	Descrição
`ARRAY`	Retorna um `ARRAY` que contém um elemento para cada argumento de entrada.
`ARRAY_CONCAT`	Concatena várias matrizes em um único `ARRAY`
`ARRAY_CONTAINS`	Retorna `TRUE` se um determinado `ARRAY` contém um valor específico.
`ARRAY_CONTAINS_ALL`	Retorna `TRUE` se todos os valores estiverem presentes no `ARRAY`.
`ARRAY_CONTAINS_ANY`	Retorna `TRUE` se algum dos valores estiver presente no `ARRAY`
`ARRAY_GET`	Retorna o elemento em um determinado índice em um `ARRAY`
`ARRAY_LENGTH`	Retorna o número de elementos em um `ARRAY`
`ARRAY_REVERSE`	Inverte a ordem dos elementos em um `ARRAY`.
`SUM`	Retorna a soma de todos os valores `NUMERIC` em um `ARRAY`.
`JOIN`	Produz uma concatenação dos elementos em um `ARRAY` como um valor `STRING`.

ARRAY

Sintaxe:

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

Descrição:

Cria uma matriz com base nos elementos fornecidos.

Se um argumento não existir, ele será substituído por NULL na matriz resultante.

Exemplos:

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

Sintaxe:

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

Descrição:

Concatena duas ou mais matrizes em um único ARRAY.

Exemplos:

matrizes	`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

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

ARRAY_CONTAINS

Sintaxe:

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

Descrição:

Retorna TRUE se value for encontrado no array. Caso contrário, retorna FALSE.

Exemplos:

matriz	valor	`array_contains(array, value)`
[1, 2, 3]	2	verdadeiro
[[1, 2], [3]]	[1, 2]	verdadeiro
[1, null]	null	verdadeiro
"abc"	ANY	erro

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

ARRAY_CONTAINS_ALL

Sintaxe:

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

Descrição:

Retorna TRUE se todos os search_values forem encontrados no array. Caso contrário, retorna FALSE.

Exemplos:

matriz	search_values	`array_contains_all(array, search_values)`
[1, 2, 3]	[1, 2]	verdadeiro
[1, 2, 3]	[1, 4]	falso
[1, null]	[null]	verdadeiro
[NaN]	[NaN]	verdadeiro
[]	[]	verdadeiro
[1, 2, 3]	[]	verdadeiro

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

ARRAY_CONTAINS_ANY

Sintaxe:

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

Descrição:

Retorna TRUE se um dos search_values for encontrado no array. Caso contrário, retorna FALSE.

Exemplos:

matriz	search_values	`array_contains_any(array, search_values)`
[1, 2, 3]	[4, 1]	verdadeiro
[1, 2, 3]	[4, 5]	falso
[1, 2, null]	[null]	verdadeiro

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

ARRAY_GET

Sintaxe:

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

Descrição:

Retorna o elemento no index baseado em zero em array.

Se index for negativo, os elementos serão acessados do final da matriz, em que -1 é o último elemento.
Se array não for do tipo ARRAY, a função vai retornar um valor ausente.
Se index estiver fora dos limites, a função vai retornar um valor ausente.
Se index não for do tipo INT64, a função vai retornar um erro.

Exemplos:

matriz	index	`array_get(array, index)`
[1, 2, 3]	0	1
[1, 2, 3]	-1	3
[1, 2, 3]	3	ausente
[1, 2, 3]	-4	ausente
"abc"	0	ausente
null	0	ausente
`Array`	"a"	erro
`Array`	2,0	erro

ARRAY_LENGTH

Sintaxe:

array_length(array: ARRAY) -> INT64

Descrição:

Retorna o número de elementos em um array.

Exemplos:

matriz	`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

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

ARRAY_REVERSE

Sintaxe:

array_reverse(array: ARRAY) -> ARRAY

Descrição:

Inverte o array especificado.

Exemplos:

matriz	`array_reverse(array)`
[1, 2, 3]	[3, 2, 1]
["a", "b"]	["b", "a"]
[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

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

SUM

Sintaxe:

sum(array: ARRAY) -> INT64 | FLOAT64

Descrição:

Retorna a soma de todos os valores NUMERIC em um ARRAY.

Valores não numéricos na matriz são ignorados.
Se algum valor numérico na matriz for NaN, a função retornará NaN.
O tipo de retorno é determinado pelo tipo numérico mais amplo na matriz: INT64 < FLOAT64.
Se um número inteiro flutuante de 64 bits ocorrer antes que qualquer valor de ponto flutuante seja somado, um erro será retornado. Se valores de ponto flutuante forem somados, o valor flutuante vai resultar em +/- infinito.
Se a matriz não tiver valores numéricos, a função vai retornar NULL.

Exemplos:

matriz	`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]	erro
[INT64.MAX_VALUE, 1, -1.0]	erro
[INT64.MAX_VALUE, 1.0]	9.223372036854776e+18

PARTICIPAR

Sintaxe:

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

Descrição:

Retorna uma concatenação dos elementos em array como um STRING. O array pode ser dos tipos de dados STRING ou BYTES.

Todos os elementos em array, delimiter e null_text precisam ser do mesmo tipo: todos precisam ser STRING ou BYTES.
Se null_text for fornecido, todos os valores NULL em array serão substituídos por null_text.
Se null_text não for fornecido, os valores NULL em array serão omitidos do resultado.

Exemplos:

Quando null_text não é fornecido:

matriz	delimitador	`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']	","	erro
["a", "c"]	b','	erro
[b'a', b'c']	","	erro

Quando null_text é fornecido:

matriz	delimitador	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'	erro
[b'a', null]	b','	"N"	erro

Funções de matriz Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.