REST Resource: projects.databases.collectionGroups.indexes

Kaynak: Dizin

Cloud Firestore dizinleri, veritabanındaki belgelerde basit ve karmaşık sorgular yapılmasına olanak tanır.

JSON gösterimi 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Alanlar
name

string

Yalnızca çıkış. Bu dizin için sunucu tanımlı bir ad. Bileşik dizinler için bu adın biçimi şöyledir: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Tek alanlı dizinler için bu alan boş bırakılır.
queryScope

enum (QueryScope)

Koleksiyon sorgu kapsamı belirtilen dizinler; sorgu zamanında belirtilen ve aynı koleksiyon kimliğine sahip belirli bir dokümanın alt öğesi olan bir koleksiyona yönelik sorgulara izin verir.

Belirtilen koleksiyon grubu sorgu kapsamına sahip dizinler, belirli bir dokümandan türetilen, sorgu zamanında belirtilen ve bu dizinle aynı koleksiyon kimliğine sahip tüm koleksiyonlarda sorgulara izin verir.
fields[]

object (IndexField)

Bu dizin tarafından desteklenen alanlar.

Bileşik dizinler için bu her zaman 2 veya daha fazla alandır. 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 alanla aynı yönde otomatik olarak eklenir. Bileşik bir dizindeki son alan yönlü değilse __name__, ASCENDING olarak sıralanır (açıkça belirtilmedikçe).

Tek alanlı dizinler için bu, her zaman ilişkili alanın alan yoluna eşit olan bir alan yoluna sahip tam olarak tek bir giriş olacaktır.
state

enum (State)

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

Yöntemler

create

 Bileşik bir dizin oluşturur.

delete

 Bileşik bir dizin siler.

get

 Bileşik bir dizin alır.

list

 Bileşik dizinleri listeler.