REST Resource: projects.databases.collectionGroups.indexes

Sumber: Indeks

Indeks Cloud Firestore memungkinkan kueri sederhana dan kompleks terhadap dokumen dalam database.

Representasi JSON
{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Bidang
name

string

Hanya keluaran. Nama yang ditentukan server untuk indeks ini. Bentuk nama indeks gabungan ini adalah: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Untuk indeks bidang tunggal, bidang ini akan kosong.

queryScope

enum ( QueryScope )

Indeks dengan cakupan kueri koleksi yang ditentukan memungkinkan kueri terhadap koleksi yang merupakan turunan dari dokumen tertentu, ditentukan pada waktu kueri, dan memiliki id koleksi yang sama.

Indeks dengan cakupan kueri grup koleksi yang ditentukan memungkinkan kueri terhadap semua koleksi yang diturunkan dari dokumen tertentu, ditentukan pada waktu kueri, dan yang memiliki id koleksi yang sama dengan indeks ini.

fields[]

object ( IndexField )

Bidang yang didukung oleh indeks ini.

Untuk indeks gabungan, bidang ini selalu terdiri dari 2 bidang atau lebih. Entri bidang terakhir selalu untuk jalur bidang __name__ . Jika, pada saat pembuatan, __name__ tidak ditentukan sebagai kolom terakhir, maka akan ditambahkan secara otomatis dengan arah yang sama dengan kolom terakhir yang ditentukan. Jika bidang terakhir dalam indeks komposit tidak terarah, __name__ akan diurutkan ASCENDING (kecuali ditentukan secara eksplisit).

Untuk indeks bidang tunggal, ini akan selalu berupa satu entri dengan jalur bidang yang sama dengan jalur bidang dari bidang terkait.

state

enum ( State )

Hanya keluaran. Status penyajian indeks.

Metode

create

Membuat indeks komposit.

delete

Menghapus indeks komposit.

get

Mendapat indeks komposit.

list

Mencantumkan indeks komposit.