REST Resource: projects.databases.indexes

Resource: Indeks

Definisi indeks.

Representasi JSON 
{
  "name": string,
  "collectionId": string,
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Kolom
name

string

Nama resource indeks. Hanya output.
collectionId

string

ID koleksi tempat indeks ini berlaku. Wajib diisi.
fields[]

object (IndexField)

Kolom yang akan diindeks.
state

enum (State)

Status indeks. Hanya output.

KolomIndeks

Kolom indeks.

Representasi JSON 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
Kolom
fieldPath

string

Jalur kolom. Harus cocok dengan spesifikasi jalur kolom yang dijelaskan oleh [google.firestore.v1beta1.Document.fields][fields]. Jalur kolom khusus __name__ dapat digunakan sendiri atau di akhir jalur. __type__ hanya dapat digunakan di akhir jalur.
mode

enum (Mode)

Mode kolom.

Mode

Mode ini menentukan cara kolom diindeks.

Enum
MODE_UNSPECIFIED Modenya 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 bertransisi ke status READY. Jika tidak dapat dibuat, indeks akan ditransisikan ke status ERROR.

Enum
STATE_UNSPECIFIED Status tidak ditentukan.
CREATING Indeks sedang dibuat. Ada operasi aktif yang berjalan lama untuk indeks. Indeks diperbarui saat menulis dokumen. Beberapa data indeks mungkin ada.
READY Indeks siap digunakan. Indeks diperbarui saat menulis dokumen. Indeks terisi sepenuhnya dari semua dokumen tersimpan yang berlaku.
ERROR Indeks sedang dibuat, tetapi terjadi error. Tidak ada operasi yang berjalan lama yang aktif untuk indeks, dan operasi yang berjalan lama yang baru saja selesai gagal. Indeks tidak diperbarui saat menulis dokumen. Beberapa data indeks mungkin ada.

Metode

create

 Membuat indeks yang ditentukan.

delete

 Menghapus indeks.

get

 Mendapatkan indeks.

list

 Mencantumkan indeks yang cocok dengan filter yang ditentukan.