REST Resource: projects.databases.collectionGroups.indexes

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

string

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

enum (QueryScope)

Indeks dengan cakupan kueri koleksi yang ditentukan memungkinkan kueri terhadap koleksi yang merupakan turunan dokumen tertentu, 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, ditentukan pada waktu kueri, dan yang memiliki ID koleksi yang sama dengan indeks ini.

enum (ApiScope)

Cakupan API yang didukung oleh indeks ini.

object (IndexField)

Kolom yang didukung oleh indeks ini.

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

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

enum (State)

Hanya output. Status penayangan indeks.