REST Resource: projects.databases.collectionGroups.indexes

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

string

Yalnızca çıkış. Bu dizin için sunucu tarafından tanımlanan bir ad. Bileşik dizinler için bu adın biçimi şu şekildedir: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Tek alanlı dizinler için bu alan boş olur.

enum (QueryScope)

Koleksiyon sorgusu kapsamının belirtildiği dizinler, belirli bir belgenin alt öğesi olan, sorgu sırasında belirtilen ve aynı koleksiyon kimliğine sahip bir koleksiyonda sorgulara izin verir.

Koleksiyon grubu sorgu kapsamına sahip olan dizinler, belirli bir belgeden türetilmiş olan, sorgu sırasında belirtilen ve bu dizinle aynı koleksiyon kimliğine sahip olan tüm koleksiyonlarda yapılan sorgulara izin verir.

enum (ApiScope)

Bu dizin tarafından desteklenen API kapsamı.

object (IndexField)

Bu dizin tarafından desteklenen alanlar.

Bileşik dizinler için bu, en az 2 ve en fazla 100 alan gerektirir. Son alan girişi her zaman __name__ alan yolu içindir. Oluşturma sırasında __name__ son alan olarak belirtilmemişse, tanımlanan son alanın yönüyle aynı yönde otomatik olarak eklenir. Bileşik dizindeki son alan yönlü değilse __name__, ASCENDING (açıkça belirtilmedikçe) olarak sıralanır.

Tek alan dizinlerinde bu, her zaman ilişkili alanın alan yoluna eşit bir alan yoluna sahip tam olarak tek bir giriş olacaktır.

enum (State)

Yalnızca çıkış. Dizinin sunulma durumu.