Resource: Indeks
Definisi indeks.
Representasi JSON |
---|
{ "name": string, "collectionId": string, "fields": [ { object ( |
Kolom | |
---|---|
name |
Nama resource indeks. Hanya output. |
collectionId |
ID koleksi yang akan diberlakukan indeks ini. Wajib. |
fields[] |
Kolom yang akan diindeks. |
state |
Status indeks. Hanya output. |
IndexField
Kolom indeks.
Representasi JSON |
---|
{
"fieldPath": string,
"mode": enum ( |
Kolom | |
---|---|
fieldPath |
Jalur kolom. Harus cocok dengan spesifikasi jalur kolom yang dijelaskan oleh [google.firestore.v1beta1.Document.fields][fields]. Jalur kolom khusus |
mode |
Mode kolom. |
Mode
Mode ini menentukan cara kolom diindeks.
Enum | |
---|---|
MODE_UNSPECIFIED |
Mode tidak ditentukan. |
ASCENDING |
Nilai kolom diindeks untuk mendukung pengurutan dalam urutan menaik dan juga membuat kueri berdasarkan <, >, <=, >=, dan =. |
DESCENDING |
Nilai kolom diindeks untuk mendukung pengurutan dalam urutan menurun dan juga membuat kueri berdasarkan <, >, <=, >=, dan =. |
ARRAY_CONTAINS |
Nilai array kolom diindeks untuk mendukung keanggotaan menggunakan kueri ARRAY_CONTAINS. |
Negara Bagian
Status indeks. Selama pembuatan indeks, indeks akan berada dalam status CREATING
. Jika berhasil dibuat, indeks akan beralih ke status READY
. Jika tidak dapat dibuat, indeks akan beralih ke status ERROR
.
Enum | |
---|---|
STATE_UNSPECIFIED |
Status tidak ditentukan. |
CREATING |
Indeks sedang dibuat. Ada operasi jangka panjang yang aktif untuk indeks. Indeks diperbarui saat menulis dokumen. Beberapa data indeks mungkin ada. |
READY |
Indeks siap digunakan. Indeks diperbarui saat menulis dokumen. Indeks terisi penuh dari semua dokumen tersimpan yang berlaku untuknya. |
ERROR |
Indeks sedang dibuat, tetapi terjadi masalah. Tidak ada operasi jangka panjang yang aktif untuk indeks, dan operasi jangka panjang yang baru saja diselesaikan gagal. Indeks tidak diperbarui saat menulis dokumen. Beberapa data indeks mungkin ada. |
Metode |
|
---|---|
|
Membuat indeks yang ditentukan. |
|
Menghapus indeks. |
|
Mendapatkan indeks. |
|
Mencantumkan indeks yang cocok dengan filter yang ditentukan. |