Referensi Fungsi Array
Fungsi Array
| Nama | Deskripsi |
ARRAY
|
Menampilkan ARRAY yang berisi satu elemen untuk setiap argumen input
|
ARRAY_CONCAT
|
Menggabungkan beberapa array menjadi satu ARRAY
|
ARRAY_CONTAINS
|
Menampilkan TRUE jika suatu ARRAY berisi nilai tertentu
|
ARRAY_CONTAINS_ALL
|
Menampilkan TRUE jika semua nilai ada dalam ARRAY
|
ARRAY_CONTAINS_ANY
|
Menampilkan TRUE jika salah satu nilai ada dalam ARRAY
|
ARRAY_FILTER
|
Memfilter elemen dari ARRAY yang tidak memenuhi predikat
|
ARRAY_FIRST
|
Menampilkan elemen pertama dalam ARRAY
|
ARRAY_FIRST_N
|
Menampilkan n elemen pertama dalam ARRAY
|
ARRAY_GET
|
Menampilkan elemen pada indeks tertentu dalam suatu ARRAY
|
ARRAY_INDEX_OF
|
Menampilkan indeks kemunculan pertama nilai dalam ARRAY
|
ARRAY_INDEX_OF_ALL
|
Menampilkan semua indeks nilai dalam ARRAY
|
ARRAY_LENGTH
|
Menampilkan jumlah elemen dalam ARRAY
|
ARRAY_LAST
|
Menampilkan elemen terakhir dalam ARRAY
|
ARRAY_LAST_N
|
Menampilkan n elemen terakhir dalam ARRAY
|
ARRAY_REVERSE
|
Membalikkan urutan elemen dalam ARRAY
|
ARRAY_SLICE
|
Menampilkan slice ARRAY
|
ARRAY_TRANSFORM
|
Mengubah elemen dalam ARRAY dengan menerapkan ekspresi ke setiap elemen
|
MAXIMUM
|
Menampilkan nilai maksimum dalam ARRAY
|
MAXIMUM_N
|
Menampilkan n nilai terbesar dalam ARRAY
|
MINIMUM
|
Menampilkan nilai minimum dalam ARRAY
|
MINIMUM_N
|
Menampilkan n nilai terkecil dalam ARRAY
|
SUM
|
Menampilkan hasil penjumlahan semua nilai NUMERIC dalam ARRAY.
|
JOIN
|
Menghasilkan penyambungan elemen dalam ARRAY sebagai nilai STRING.
|
ARRAY
Sintaksis:
array(values: ANY...) -> ARRAY
Deskripsi:
Menyusun array dari elemen yang diberikan.
- Jika argumen tidak ada, penggantinya adalah
NULLdalam array yang dihasilkan.
Contoh:
| nilai | 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
Sintaksis:
array_concat(arrays: ARRAY...) -> ARRAY
Deskripsi:
Menyambungkan dua array atau lebih menjadi satu ARRAY.
Contoh:
| arrays | 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();
Swift
let result = try await db.pipeline() .collection("books") .select([Field("genre").arrayConcat([Field("subGenre")]).as("allGenres")]) .execute()
Kotlin
Android
val result = db.pipeline() .collection("books") .select(field("genre").arrayConcat(field("subGenre")).alias("allGenres")) .execute()
Java
Android
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() )
Java
Pipeline.Snapshot result = firestore .pipeline() .collection("books") .select(arrayConcat(field("genre"), field("subGenre")).as("allGenres")) .execute() .get();
ARRAY_CONTAINS
Sintaksis:
array_contains(array: ARRAY, value: ANY) -> BOOLEAN
Deskripsi:
Menampilkan TRUE jika value ditemukan dalam array, dan FALSE jika sebaliknya.
Contoh:
| array | nilai | array_contains(array, value) |
|---|---|---|
| [1, 2, 3] | 2 | true |
| [[1, 2], [3]] | [1, 2] | true |
| [1, null] | null | true |
| "abc" | ANY | error |
Node.js
const result = await db.pipeline() .collection("books") .select(field("genre").arrayContains(constant("mystery")).as("isMystery")) .execute();
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
Android
val result = db.pipeline() .collection("books") .select(field("genre").arrayContains("mystery").alias("isMystery")) .execute()
Java
Android
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() )
Java
Pipeline.Snapshot result = firestore .pipeline() .collection("books") .select(arrayContains(field("genre"), "mystery").as("isMystery")) .execute() .get();
ARRAY_CONTAINS_ALL
Sintaksis:
array_contains_all(array: ARRAY, search_values: ARRAY) -> BOOLEAN
Deskripsi:
Menampilkan TRUE jika semua search_values ditemukan dalam array, dan FALSE jika sebaliknya.
Contoh:
| array | search_values | array_contains_all(array, search_values) |
|---|---|---|
| [1, 2, 3] | [1, 2] | true |
| [1, 2, 3] | [1, 4] | false |
| [1, null] | [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();
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
Android
val result = db.pipeline() .collection("books") .select( field("genre") .arrayContainsAll(listOf("fantasy", "adventure")) .alias("isFantasyAdventure") ) .execute()
Java
Android
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() )
Java
Pipeline.Snapshot result = firestore .pipeline() .collection("books") .select( arrayContainsAll(field("genre"), Arrays.asList("fantasy", "adventure")) .as("isFantasyAdventure")) .execute() .get();
ARRAY_CONTAINS_ANY
Sintaksis:
array_contains_any(array: ARRAY, search_values: ARRAY) -> BOOLEAN
Deskripsi:
Menampilkan TRUE jika salah satu dari search_values ditemukan dalam array, dan FALSE jika sebaliknya.
Contoh:
| array | search_values | array_contains_any(array, search_values) |
|---|---|---|
| [1, 2, 3] | [4, 1] | true |
| [1, 2, 3] | [4, 5] | false |
| [1, 2, null] | [null] | true |
Node.js
const result = await db.pipeline() .collection("books") .select( field("genre") .arrayContainsAny([constant("fantasy"), constant("nonfiction")]) .as("isMysteryOrFantasy") ) .execute();
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
Android
val result = db.pipeline() .collection("books") .select( field("genre") .arrayContainsAny(listOf("fantasy", "nonfiction")) .alias("isMysteryOrFantasy") ) .execute()
Java
Android
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() )
Java
Pipeline.Snapshot result = firestore .pipeline() .collection("books") .select( arrayContainsAny(field("genre"), Arrays.asList("fantasy", "nonfiction")) .as("isMysteryOrFantasy")) .execute() .get();
ARRAY_FILTER
Sintaksis:
array_filter(array: ARRAY, predicate: (ANY) -> BOOLEAN) -> ARRAY
Deskripsi:
Memfilter array menggunakan ekspresi predicate, menampilkan array baru dengan hanya elemen yang memenuhi predikat.
- Untuk setiap elemen di
array,predicatedievaluasi. Jika menampilkantrue, elemen disertakan dalam hasil; jika tidak (apabila menampilkanfalseataunull), elemen akan dihilangkan. - Jika
predicatedievaluasi ke nilai non-boolean atau non-null, fungsi ini akan menampilkan error.
Contoh:
| array | predikat | 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
Sintaksis:
array_get(array: ARRAY, index: INT64) -> ANY
Deskripsi:
Menampilkan elemen pada index berbasis 0 dalam array.
- Jika
indexbernilai negatif, elemen akan diakses dari akhir array, dengan-1sebagai elemen terakhir. - Jika
arraybukan berjenisARRAYdan bukannull, fungsi ini akan menampilkan error. - Jika
indexberada di luar batas, fungsi ini akan menampilkan nilai kosong. - Jika
indexbukan berjenisINT64, fungsi ini akan menampilkan error.
Contoh:
| array | indeks | array_get(array, index) |
|---|---|---|
| [1, 2, 3] | 0 | 1 |
| [1, 2, 3] | -1 | 3 |
| [1, 2, 3] | 3 | tidak ada |
| [1, 2, 3] | -4 | tidak ada |
| "abc" | 0 | error |
| null | 0 | null |
Array |
"a" | error |
Array |
2.0 | error |
ARRAY_LENGTH
Sintaksis:
array_length(array: ARRAY) -> INT64
Deskripsi:
Menampilkan jumlah elemen dalam array.
Contoh:
| 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();
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
Android
val result = db.pipeline() .collection("books") .select(field("genre").arrayLength().alias("genreCount")) .execute()
Java
Android
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() )
Java
Pipeline.Snapshot result = firestore .pipeline() .collection("books") .select(arrayLength(field("genre")).as("genreCount")) .execute() .get();
ARRAY_REVERSE
Sintaksis:
array_reverse(array: ARRAY) -> ARRAY
Deskripsi:
Membalikkan array yang diberikan.
Contoh:
| 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();
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
Android
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();
Android
Python
from google.cloud.firestore_v1.pipeline_expressions import Field result = ( client.pipeline() .collection("books") .select(Field.of("genre").array_reverse().as_("reversedGenres")) .execute() )
Java
Pipeline.Snapshot result = firestore .pipeline() .collection("books") .select(arrayReverse(field("genre")).as("reversedGenres")) .execute() .get();
ARRAY_FIRST
Sintaksis:
array_first(array: ARRAY) -> ANY
Deskripsi:
Menampilkan elemen pertama dalam array. Fungsi ini setara dengan array_get(array, 0).
- Jika
arraykosong, fungsi ini akan menampilkan nilai absent.
Contoh:
| array | array_first(array) |
|---|---|
| [1, 2, 3] | 1 |
| [] | tidak ada |
ARRAY_FIRST_N
Sintaksis:
array_first_n(array: ARRAY, n: INT64) -> ARRAY
Deskripsi:
Menampilkan n elemen pertama dari array. Fungsi ini setara dengan array_slice(array, 0, n).
- Jika
nbernilai negatif, fungsi ini akan menampilkan error.
Contoh:
| array | 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
Sintaksis:
array_index_of(array: ARRAY, value: ANY) -> INT64
Deskripsi:
Menampilkan indeks berbasis 0 dari kemunculan pertama value dalam array. Menampilkan -1 jika value tidak ditemukan.
Contoh:
| array | nilai | 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
Sintaksis:
array_index_of_all(array: ARRAY, value: ANY) -> ARRAY<INT64>
Deskripsi:
Menampilkan array yang berisi indeks berbasis 0 dari semua kemunculan value dalam array. Menampilkan [] jika value tidak ditemukan.
Contoh:
| array | nilai | 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
Sintaksis:
array_last(array: ARRAY) -> ANY
Deskripsi:
Menampilkan elemen terakhir dalam array. Fungsi ini setara dengan array_get(array, -1).
- Jika
arraykosong, fungsi ini akan menampilkan nilai absent.
Contoh:
| array | array_last(array) |
|---|---|
| [1, 2, 3] | 3 |
| [] | tidak ada |
ARRAY_LAST_N
Sintaksis:
array_last_n(array: ARRAY, n: INT64) -> ARRAY
Deskripsi:
Menampilkan n elemen terakhir dari array.
- Jika
nbernilai negatif, fungsi ini akan menampilkan error.
Contoh:
| array | 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
Sintaksis:
array_slice(array: ARRAY, offset: INT64, length: INT64) -> ARRAY
Deskripsi:
Menampilkan sebagian array yang dimulai dari offset indeks berbasis 0, dan menyertakan length elemen.
- Jika
offsetbernilai negatif, fungsi ini akan menunjukkan posisi awal dari akhir array, dengan-1sebagai elemen terakhir. - Jika
lengthlebih besar daripada jumlah elemen yang tersisa dalam array setelahoffset, hasilnya akan diperluas hingga akhir array. lengthtidak boleh bernilai negatif karena akan menghasilkan error.
Contoh:
| array | offset | panjang | 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
Sintaksis:
array_transform(array: ARRAY, expression: (ANY) -> ANY) -> ARRAY
array_transform(array: ARRAY, expression: (ANY, INT64) -> ANY) -> ARRAY
Deskripsi:
Mentransformasi array dengan menerapkan expression ke setiap elemen, menampilkan array baru dengan elemen yang ditransformasi. Array output akan selalu memiliki ukuran yang sama dengan array input.
expressiondapat berupa fungsi unaryelement -> result, atau fungsi biner(element, index) -> result.- Jika
expressionbersifat unary, fungsi ini dipanggil dengan setiap elemenarray. - Jika
expressionadalah biner, maka akan dipanggil dengan setiap elemenarraydan indeks berbasis 0 yang sesuai.
Contoh:
| array | ekspresi | 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
Sintaksis:
maximum(array: ARRAY) -> ANY
Deskripsi:
Menampilkan nilai maksimum dalam array.
- Nilai
NULLakan diabaikan selama perbandingan. - Jika
arraykosong atau hanya berisi nilaiNULL, fungsi ini akan menampilkanNULL.
Contoh:
| array | maximum(array) |
|---|---|
| [1, 5, 2] | 5 |
| [1, null, 5] | 5 |
| ["a", "c", "b"] | "c" |
| [null, null] | null |
| [] | null |
MAXIMUM_N
Sintaksis:
maximum_n(array: ARRAY, n: INT64) -> ARRAY
Deskripsi:
Menampilkan array dari n nilai terbesar dalam array dengan urutan menurun.
- Nilai
NULLakan diabaikan. - Jika
nbernilai negatif, fungsi ini akan menampilkan error.
Contoh:
| array | n | maximum_n(array, n) |
|---|---|---|
| [1, 5, 2, 4, 3] | 3 | [5, 4, 3] |
| [1, null, 5] | 3 | [5, 1] |
MINIMUM
Sintaksis:
minimum(array: ARRAY) -> ANY
Deskripsi:
Menampilkan nilai minimum dalam array.
- Nilai
NULLakan diabaikan selama perbandingan. - Jika
arraykosong atau hanya berisi nilaiNULL, fungsi ini akan menampilkanNULL.
Contoh:
| array | minimum(array) |
|---|---|
| [1, 5, 2] | 1 |
| [5, null, 1] | 1 |
| ["a", "c", "b"] | "a" |
| [null, null] | null |
| [] | null |
MINIMUM_N
Sintaksis:
minimum_n(array: ARRAY, n: INT64) -> ARRAY
Deskripsi:
Menampilkan array dari n nilai terkecil dalam array dengan urutan naik.
- Nilai
NULLakan diabaikan. - Jika
nbernilai negatif, fungsi ini akan menampilkan error.
Contoh:
| array | n | minimum_n(array, n) |
|---|---|---|
| [1, 5, 2, 4, 3] | 3 | [1, 2, 3] |
| [5, null, 1] | 3 | [1, 5] |
SUM
Sintaksis:
sum(array: ARRAY) -> INT64 | FLOAT64
Deskripsi:
Menampilkan hasil penjumlahan semua nilai NUMERIC dalam ARRAY.
- Nilai non-numerik dalam array akan diabaikan.
- Jika ada nilai numerik dalam array yang bernilai
NaN, fungsi ini akan menampilkanNaN. - Jenis nilai yang ditampilkan ditentukan oleh jenis numerik terluas dalam array:
INT64<FLOAT64. - Jika terjadi overflow bilangan bulat 64-bit sebelum nilai floating point dijumlahkan, fungsi ini akan menampilkan error. Jika nilai floating point dijumlahkan, overflow akan menghasilkan +/- tak terhingga.
- Jika array tidak berisi nilai numerik sama sekali, fungsi ini akan menampilkan
NULL.
Contoh:
| 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] | error |
| [INT64.MAX_VALUE, 1, -1.0] | error |
| [INT64.MAX_VALUE, 1.0] | 9.223372036854776e+18 |
GABUNG
Sintaksis:
join[T <: STRING | BYTES](array: ARRAY<T>, delimiter: T) -> STRING
join[T <: STRING | BYTES](array: ARRAY<T>, delimiter: T, null_text: T) -> STRING
Deskripsi:
Menampilkan penyambungan elemen dalam array sebagai STRING. array dapat berupa jenis data STRING atau BYTES.
- Semua elemen dalam
array,delimiter, dannull_textharus memiliki jenis yang sama; semuanya harus berupaSTRINGatauBYTES. - Jika
null_textdiberikan, semua nilaiNULLdalamarrayakan diganti dengannull_text. - Jika
null_texttidak diberikan, nilaiNULLdalamarrayakan dihilangkan dari hasil.
Contoh:
Jika null_text tidak diberikan:
| array | pembatas | 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'] | "," | error |
| ["a", "c"] | b',' | error |
| [b'a', b'c'] | "," | error |
Jika null_text diberikan:
| array | pembatas | 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' | error |
| [b'a', null] | b',' | "N" | error |
Langkah berikutnya
- Lihat ringkasan Kueri Pipeline