REST Resource: projects.databases.indexes

Kaynak: Dizin

Dizin tanımı.

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

string

Dizinin kaynak adı. Yalnızca çıkış.
collectionId

string

Bu dizinin geçerli olduğu koleksiyon kimliği. Zorunlu.
fields[]

object (IndexField)

Dizine eklenecek alanlar.
state

enum (State)

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

IndexField

Dizin alanı.

JSON gösterimi 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
Alanlar
fieldPath

string

Alanın yolu. [google.firestore.v1beta1.Document.fields][fields] tarafından açıklanan alan yolu spesifikasyonuyla eşleşmelidir. __name__ özel alan yolu tek başına veya bir yolun sonunda kullanılabilir. __type__ yalnızca yolun sonunda kullanılabilir.
mode

enum (Mode)

Alanın modu.

Mod

Bu mod, bir alanın nasıl dizine ekleneceğini belirler.

Sıralamalar
MODE_UNSPECIFIED Mod belirtilmedi.
ASCENDING Alanın değerleri, artan düzende sıralamayı destekleyecek ve <, >, <=, >= ve = ile sorgulanmasını destekleyecek şekilde dizine eklenir.
DESCENDING Alanın değerleri, azalan düzende sıralamayı destekleyecek şekilde ve <, >, <=, >= ve = ile sorgulamayı destekleyecek şekilde dizine eklenir.
ARRAY_CONTAINS Alanın dizi değerleri, ARRAY_CONTAINS sorguları kullanılarak üyeliği desteklemek için dizine eklenir.

Eyalet

Bir dizinin durumudur. Dizin oluşturma sırasında, bir dizin CREATING durumunda olur. Dizin başarıyla oluşturulursa READY durumuna geçer. Dizin oluşturulamıyorsa ERROR durumuna geçer.

Sıralamalar
STATE_UNSPECIFIED Durum belirtilmemiş.
CREATING Dizin oluşturuluyor. Dizin için uzun süreli etkin bir işlem mevcut. Doküman yazılırken dizin güncellenir. Bazı dizin verileri mevcut olabilir.
READY Dizin kullanıma hazır. Doküman yazılırken dizin güncellenir. Dizin, geçerli olduğu tüm depolanan dokümanlardan tamamen doldurulur.
ERROR Dizin oluşturuluyor ancak bir sorun oluştu. Dizin için etkin bir uzun süreli işlem yok ve en son tamamlanan uzun süreli işlem başarısız oldu. Doküman yazılırken dizin güncellenmez. Bazı dizin verileri mevcut olabilir.

Yöntemler

create

 Belirtilen dizini oluşturur.

delete

 Bir dizini siler.

get

 Bir dizin alır.

list

 Belirtilen filtrelerle eşleşen dizinleri listeler.