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_GET Menampilkan elemen pada indeks tertentu dalam suatu ARRAY
ARRAY_LENGTH Menampilkan jumlah elemen dalam ARRAY
ARRAY_REVERSE Membalikkan urutan elemen 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 NULL dalam 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]

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

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

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

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

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

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

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

Sintaksis:

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

Deskripsi:

Menampilkan elemen pada index berbasis 0 dalam array.

  • Jika index bernilai negatif, elemen akan diakses dari akhir array, dengan -1 sebagai elemen terakhir.
  • Jika array bukan berjenis ARRAY, fungsi ini akan menampilkan nilai kosong.
  • Jika index berada di luar batas, fungsi ini akan menampilkan nilai kosong.
  • Jika index bukan berjenis INT64, fungsi ini akan menampilkan error.

Contoh:

array index array_get(array, index)
[1, 2, 3] 0 1
[1, 2, 3] -1 3
[1, 2, 3] 3 absent
[1, 2, 3] -4 absent
"abc" 0 absent
null 0 absent
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

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

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]

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

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 menampilkan NaN.
  • 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, dan null_text harus memiliki jenis yang sama; semuanya harus berupa STRING atau BYTES.
  • Jika null_text diberikan, semua nilai NULL dalam array akan diganti dengan null_text.
  • Jika null_text tidak diberikan, nilai NULL dalam array akan 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