REST Resource: projects.databases.collectionGroups.fields

Kaynak: Alan

Veritabanındaki tek bir alanı temsil eder.

Alanlar, veritabanındaki aynı kimliğe sahip tüm koleksiyonları temsil eden "Koleksiyon Grubu"na göre gruplandırılır.

JSON gösterimi
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  }
}
Alanlar
name

string

projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} biçimindeki alan adı

Alan yolu, basit bir alan adı (ör. address) veya matchValue içindeki alanlara giden bir yol (ör. address.city) ya da özel bir alan yolu olabilir. Geçerli tek özel alan, herhangi bir alanı temsil eden *'dir.

Alan yolları, (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` ifadeleri ve ASCII sembolik karakterleri kullanılarak alıntılanabilir.

Örnekler: (Not: Buradaki yorumlar, markdown söz dizimiyle yazılır. Bu nedenle, bir kod bloğunu temsil eden ek bir vurgu işareti katmanı vardır) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, herhangi bir alan değildir.

Özel bir Field, tüm alanlar için varsayılan dizine ekleme ayarlarını içerir. Bu alanın kaynak adı: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Bu Field politikasında tanımlanan dizinler, kendi Field dizin yapılandırmasına sahip olmayan tüm alanlara uygulanır.

indexConfig

object (IndexConfig)

Bu alan için dizin yapılandırması. Politika ayarlanmadan bırakılırsa alan dizine ekleme işlemi, ancestorField tarafından tanımlanan yapılandırmaya geri döner. Bu alandaki tüm dizinleri açıkça kaldırmak için dizin listesi boş olan bir dizin yapılandırması belirtin.

IndexConfig

Bu alan için dizin yapılandırması.

JSON gösterimi
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Alanlar
indexes[]

object (Index)

Bu alanda desteklenen dizinler.

usesAncestorConfig

boolean

Yalnızca çıkış. Doğru değerine ayarlanırsa Field dizin yapılandırması, ancestorField tarafından belirtilen yapılandırmadan ayarlanır. Yanlış değerine ayarlanırsa Field dizin yapılandırması açık bir şekilde tanımlanır.

ancestorField

string

Yalnızca çıkış. Bu alanın dizin yapılandırmasının ayarlandığı (usesAncestorConfig doğru olduğunda) veya bu alanda dizin yapılandırması yoksa (usesAncestorConfig yanlış olduğunda)ayarlanacağı Field kaynak adını belirtir.

reverting

boolean

Yalnızca çıkış Doğru değerine ayarlandığında Field dizin yapılandırması geri alınma sürecindedir. İşlem tamamlandığında dizin yapılandırması, ancestorField tarafından belirtilen alanla aynı duruma geçirilir. Bu noktada usesAncestorConfig değeri true, reverting değeri ise false olur.

Yöntemler

get

Bir Alanın meta verilerini ve yapılandırmasını alır.

list

Bu veritabanı için alan yapılandırmasını ve meta verilerini listeler.

patch

Alan yapılandırmasını günceller.