REST Resource: projects.databases.collectionGroups.fields

Zasób: pole

Reprezentuje jedno pole w bazie danych.

Pola są pogrupowane według „grupy kolekcji”, która reprezentuje wszystkie kolekcje w bazie danych o tym samym identyfikatorze.

Zapis JSON 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  }
}
Pola
name

string

Nazwa pola w formacie projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Ścieżka pola może być prostą nazwą pola, np. address lub ścieżka do pól w obrębie wartości mapValue , np. address.city lub specjalną ścieżkę pola. Jedyne prawidłowe pole specjalne to *, które reprezentuje dowolne pole.

Ścieżki pól można cytować za pomocą znaków (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),[,]oraz dowolnych znaków ASCII.

Przykłady: (uwaga: komentarze w tym miejscu są napisane w składni języka markdown, dlatego pojawia się dodatkowa warstwa znaków grawisowych reprezentujących blok kodu) \address.city`represents a field namedadres.miasto, not the map key miastoin the fieldadres. `*`represents a field named*`, a nie żadne pole.

Specjalny identyfikator Field zawiera domyślne ustawienia indeksowania wszystkich pól. Nazwa zasobu tego pola to: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Indeksy zdefiniowane w tym elemencie Field zostaną zastosowane do wszystkich pól, które nie mają własnej konfiguracji indeksów Field.
indexConfig

object (IndexConfig)

Konfiguracja indeksu dla tego pola. Jeśli jej nie skonfigurujesz, indeksowanie pól zostanie przywrócone do konfiguracji zdefiniowanej przez zasadę ancestorField. Aby bezpośrednio usunąć wszystkie indeksy dla tego pola, określ konfigurację indeksu z pustą listą indeksów.

Konfiguracja indeksu

Konfiguracja indeksu dla tego pola.

Zapis JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Pola
indexes[]

object (Index)

Indeksy obsługiwane przez to pole.
usesAncestorConfig

boolean

Tylko dane wyjściowe. Jeśli zasada ma wartość prawda, konfiguracja indeksu Field jest ustawiana na podstawie konfiguracji określonej w zasadzie ancestorField. Jeśli ma wartość Fałsz, konfiguracja indeksu Field jest zdefiniowana.
ancestorField

string

Tylko dane wyjściowe. Określa nazwę zasobu pola Field, z którego skonfigurowana jest konfiguracja indeksu tego pola (gdy usesAncestorConfig ma wartość prawda) lub wartości, od której wartość ta jest ustawiana, jeśli to pole nie ma konfiguracji indeksu (gdy usesAncestorConfig ma wartość fałsz).
reverting

boolean

Tylko dane wyjściowe, jeśli ma wartość prawda, konfiguracja indeksu Field jest w trakcie przywracania. Po zakończeniu konfiguracja indeksu zmieni się na taki sam jak pole określone przez pole ancestorField. W tym momencie usesAncestorConfig będzie mieć wartość true, a reverting – false.

Metody

get

 Pobiera metadane i konfigurację pola.

list

 Zawiera konfigurację pól i metadane tej bazy danych.

patch

 Aktualizuje konfigurację pola.