Funzioni di array
| Nome | Descrizione |
ARRAY
|
Restituisce un ARRAY contenente un elemento per ogni argomento di input
|
ARRAY_CONCAT
|
Concatena più array in un unico ARRAY
|
ARRAY_CONTAINS
|
Restituisce TRUE se un determinato ARRAY contiene un valore specifico
|
ARRAY_CONTAINS_ALL
|
Restituisce TRUE se tutti i valori sono presenti in ARRAY
|
ARRAY_CONTAINS_ANY
|
Restituisce TRUE se uno dei valori è presente in ARRAY
|
ARRAY_GET
|
Restituisce l'elemento in un determinato indice di un ARRAY
|
ARRAY_LENGTH
|
Restituisce il numero di elementi in un ARRAY
|
ARRAY_REVERSE
|
Inverte l'ordine degli elementi in un ARRAY
|
SUM
|
Restituisce la somma di tutti i valori NUMERIC in un ARRAY.
|
JOIN
|
Produce una concatenazione degli elementi in un ARRAY come valore STRING.
|
ARRAY
Sintassi:
array(values: ANY...) -> ARRAY
Descrizione:
Costruisce un array dagli elementi specificati.
- Se un argomento non esiste, viene sostituito con
NULLnell'array risultante.
Esempi:
| valori | 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
Sintassi:
array_concat(arrays: ARRAY...) -> ARRAY
Descrizione:
Concatena due o più array in un unico ARRAY.
Esempi:
| 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")) );
Swift
let result = try await db.pipeline() .collection("books") .select([Field("genre").arrayConcat([Field("subGenre")]).as("allGenres")]) .execute()
Kotlin
val result = db.pipeline() .collection("books") .select(field("genre").arrayConcat(field("subGenre")).alias("allGenres")) .execute()
Java
Task<Pipeline.Snapshot> result = db.pipeline() .collection("books") .select(field("genre").arrayConcat(field("subGenre")).alias("allGenres")) .execute();
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() )
ARRAY_CONTAINS
Sintassi:
array_contains(array: ARRAY, value: ANY) -> BOOLEAN
Descrizione:
Restituisce TRUE se value viene trovato in array, altrimenti restituisce FALSE.
Esempi:
| array | valore | array_contains(array, value) |
|---|---|---|
| [1, 2, 3] | 2 | true |
| [[1, 2], [3]] | [1, 2] | true |
| [1, null] | null | true |
| "abc" | QUALSIASI | errore |
Web
const result = await execute(db.pipeline() .collection("books") .select(field("genre").arrayContains(constant("mystery")).as("isMystery")) );
Swift
let result = try await db.pipeline() .collection("books") .select([Field("genre").arrayContains(Constant("mystery")).as("isMystery")]) .execute()
Kotlin
val result = db.pipeline() .collection("books") .select(field("genre").arrayContains("mystery").alias("isMystery")) .execute()
Java
Task<Pipeline.Snapshot> result = db.pipeline() .collection("books") .select(field("genre").arrayContains("mystery").alias("isMystery")) .execute();
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() )
ARRAY_CONTAINS_ALL
Sintassi:
array_contains_all(array: ARRAY, search_values: ARRAY) -> BOOLEAN
Descrizione:
Restituisce TRUE se tutti i search_values si trovano in array, altrimenti restituisce FALSE.
Esempi:
| array | search_values | array_contains_all(array, search_values) |
|---|---|---|
| [1, 2, 3] | [1, 2] | true |
| [1, 2, 3] | [1, 4] | falso |
| [1, null] | [null] | true |
| [NaN] | [NaN] | true |
| [] | [] | true |
| [1, 2, 3] | [] | true |
Web
const result = await execute(db.pipeline() .collection("books") .select( field("genre") .arrayContainsAll([constant("fantasy"), constant("adventure")]) .as("isFantasyAdventure") ) );
Swift
let result = try await db.pipeline() .collection("books") .select([ Field("genre") .arrayContainsAll([Constant("fantasy"), Constant("adventure")]) .as("isFantasyAdventure") ]) .execute()
Kotlin
val result = db.pipeline() .collection("books") .select( field("genre") .arrayContainsAll(listOf("fantasy", "adventure")) .alias("isFantasyAdventure") ) .execute()
Java
Task<Pipeline.Snapshot> result = db.pipeline() .collection("books") .select( field("genre") .arrayContainsAll(Arrays.asList("fantasy", "adventure")) .alias("isFantasyAdventure") ) .execute();
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() )
ARRAY_CONTAINS_ANY
Sintassi:
array_contains_any(array: ARRAY, search_values: ARRAY) -> BOOLEAN
Descrizione:
Restituisce TRUE se uno qualsiasi dei search_values viene trovato in array, altrimenti restituisce FALSE.
Esempi:
| array | search_values | array_contains_any(array, search_values) |
|---|---|---|
| [1, 2, 3] | [4, 1] | true |
| [1, 2, 3] | [4, 5] | falso |
| [1, 2, null] | [null] | true |
Web
const result = await execute(db.pipeline() .collection("books") .select( field("genre") .arrayContainsAny([constant("fantasy"), constant("nonfiction")]) .as("isMysteryOrFantasy") ) );
Swift
let result = try await db.pipeline() .collection("books") .select([ Field("genre") .arrayContainsAny([Constant("fantasy"), Constant("nonfiction")]) .as("isMysteryOrFantasy") ]) .execute()
Kotlin
val result = db.pipeline() .collection("books") .select( field("genre") .arrayContainsAny(listOf("fantasy", "nonfiction")) .alias("isMysteryOrFantasy") ) .execute()
Java
Task<Pipeline.Snapshot> result = db.pipeline() .collection("books") .select( field("genre") .arrayContainsAny(Arrays.asList("fantasy", "nonfiction")) .alias("isMysteryOrFantasy") ) .execute();
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() )
ARRAY_GET
Sintassi:
array_get(array: ARRAY, index: INT64) -> ANY
Descrizione:
Restituisce l'elemento in corrispondenza dell'indice index basato su zero in array.
- Se
indexè negativo, gli elementi vengono accessibili dalla fine dell'array, dove-1è l'ultimo elemento. - Se
arraynon è di tipoARRAY, la funzione restituisce un valore assente. - Se
indexnon rientra nei limiti, la funzione restituisce un valore assente. - Se
indexnon è di tipoINT64, la funzione restituisce un errore.
Esempi:
| array | indice | array_get(array, index) |
|---|---|---|
| [1, 2, 3] | 0 | 1 |
| [1, 2, 3] | -1 | 3 |
| [1, 2, 3] | 3 | assente |
| [1, 2, 3] | -4 | assente |
| "abc" | 0 | assente |
| null | 0 | assente |
Array |
"a" | errore |
Array |
2.0 | errore |
ARRAY_LENGTH
Sintassi:
array_length(array: ARRAY) -> INT64
Descrizione:
Restituisce il numero di elementi in array.
Esempi:
| 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")) );
Swift
let result = try await db.pipeline() .collection("books") .select([Field("genre").arrayLength().as("genreCount")]) .execute()
Kotlin
val result = db.pipeline() .collection("books") .select(field("genre").arrayLength().alias("genreCount")) .execute()
Java
Task<Pipeline.Snapshot> result = db.pipeline() .collection("books") .select(field("genre").arrayLength().alias("genreCount")) .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field result = ( client.pipeline() .collection("books") .select(Field.of("genre").array_length().as_("genreCount")) .execute() )
ARRAY_REVERSE
Sintassi:
array_reverse(array: ARRAY) -> ARRAY
Descrizione:
Inverte il array specificato.
Esempi:
| array | 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")) );
Swift
let result = try await db.pipeline() .collection("books") .select([Field("genre").arrayReverse().as("reversedGenres")]) .execute()
Kotlin
val result = db.pipeline() .collection("books") .select(field("genre").arrayReverse().alias("reversedGenres")) .execute()
Java
Task<Pipeline.Snapshot> result = db.pipeline() .collection("books") .select(field("genre").arrayReverse().alias("reversedGenres")) .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field result = ( client.pipeline() .collection("books") .select(Field.of("genre").array_reverse().as_("reversedGenres")) .execute() )
SUM
Sintassi:
sum(array: ARRAY) -> INT64 | FLOAT64
Descrizione:
Restituisce la somma di tutti i valori NUMERIC in un ARRAY.
- I valori non numerici nell'array vengono ignorati.
- Se un valore numerico nell'array è
NaN, la funzione restituisceNaN. - Il tipo restituito è determinato dal tipo numerico più ampio nell'array:
INT64<FLOAT64. - Se si verifica un overflow di numeri interi a 64 bit prima che venga sommato un valore in virgola mobile, viene restituito un errore. Se vengono sommati valori in virgola mobile, l'overflow genererà +/- infinito.
- Se l'array non contiene valori numerici, la funzione restituisce
NULL.
Esempi:
| array | 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] | errore |
| [INT64.MAX_VALUE, 1, -1.0] | errore |
| [INT64.MAX_VALUE, 1.0] | 9,223372036854776e+18 |
JOIN
Sintassi:
join[T <: STRING | BYTES](array: ARRAY<T>, delimiter: T) -> STRING
join[T <: STRING | BYTES](array: ARRAY<T>, delimiter: T, null_text: T) -> STRING
Descrizione:
Restituisce una concatenazione degli elementi in array come STRING. array può essere di tipo STRING o BYTES.
- Tutti gli elementi in
array,delimiterenull_textdevono essere dello stesso tipo: devono essere tuttiSTRINGo tuttiBYTES. - Se viene fornito
null_text, tutti i valoriNULLinarrayvengono sostituiti connull_text. - Se
null_textnon viene fornito, i valoriNULLinarrayvengono omessi dal risultato.
Esempi:
Quando null_text non viene fornito:
| array | delimitatore | 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'] | "," | errore |
| ["a", "c"] | b',' | errore |
| [b'a', b'c'] | "," | errore |
Quando viene fornito null_text:
| array | delimitatore | 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' | errore |
| [b'a', null] | b',' | "N" | errore |