REST Resource: projects.databases.collectionGroups.indexes

Resource: Indeks

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

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

string

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

enum (QueryScope)

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

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

enum (ApiScope)

Cakupan API yang didukung oleh indeks ini.
fields[]

object (IndexField)

Kolom yang didukung oleh indeks ini.

Untuk indeks gabungan, parameter ini memerlukan minimal 2 dan maksimal 100 kolom. Entri kolom terakhir selalu untuk jalur kolom __name__. Jika pada saat pembuatan, __name__ tidak ditentukan sebagai kolom terakhir, kolom tersebut akan otomatis ditambahkan dengan arah yang sama dengan kolom terakhir yang ditentukan. Jika kolom terakhir dalam indeks gabungan tidak bersifat terarah, __name__ akan diurutkan menaik (kecuali jika ditetapkan secara eksplisit).

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

enum (State)

Hanya output. Status penayangan indeks.

Metode

create

 Membuat indeks gabungan.

delete

 Menghapus indeks gabungan.

get

 Mendapatkan indeks gabungan.

list

 Mencantumkan indeks gabungan.