FieldOperationMetadata

Metadane google.longrunning.Operation wyniku z FirestoreAdmin.UpdateField.

Zapis JSON
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
Pola
startTime

string (Timestamp format)

Czas rozpoczęcia tej operacji.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Czas zakończenia tej operacji. Ustawienie nie zostanie ustawione, jeśli operacja jest nadal wykonywana.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

field

string

Zasób pola, na który działa ta operacja. Na przykład: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object (IndexConfigDelta)

Lista elementów IndexConfigDelta opisujących intencję tej operacji.

state

enum (OperationState)

Stan operacji.

progressDocuments

object (Progress)

Postęp tej operacji w dokumentach.

progressBytes

object (Progress)

Postęp tej operacji w bajtach.

ttlConfigDelta

object (TtlConfigDelta)

Opisuje delta konfiguracji TTL.

IndexConfigDelta

Informacje o zmianie konfiguracji indeksu.

Zapis JSON
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
Pola
changeType

enum (ChangeType)

Określa sposób zmiany indeksu.

index

object (Index)

Zmieniany indeks.

Indeks

Indeksy Cloud Firestore umożliwiają proste i złożone zapytania dotyczące dokumentów w bazie danych.

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

string

Tylko dane wyjściowe. Zdefiniowana przez serwer nazwa tego indeksu. W przypadku indeksów złożonych postać tej nazwy będzie miała postać: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} W przypadku indeksów z pojedynczym polem to pole będzie puste.

queryScope

enum (QueryScope)

Indeksy z określonym zakresem zapytań do kolekcji umożliwiają wykonywanie zapytań na zbiorze podrzędnym określonego dokumentu, określonym w czasie wykonywania zapytania i o tym samym identyfikatorze kolekcji.

Indeksy z określonym zakresem zapytań dotyczącym grupy kolekcji zezwalają na wykonywanie zapytań dotyczących wszystkich kolekcji pochodzących z określonego dokumentu, określonych w czasie wykonywania zapytania i mających ten sam identyfikator kolekcji co ten indeks.

apiScope

enum (ApiScope)

Zakres interfejsu API obsługiwany przez ten indeks.

fields[]

object (IndexField)

Pola obsługiwane przez ten indeks.

W przypadku indeksów złożonych wymagana jest od 2 do 100 pól. Ostatni wpis w polu dotyczy zawsze ścieżki pola __name__. Jeśli podczas tworzenia pole __name__ nie zostało określone jako ostatnie pole, zostanie ono dodane automatycznie z tym samym kierunkiem co ostatnie zdefiniowane pole. Jeśli ostatnie pole w indeksie złożonym nie jest kierunkowe, pole __name__ zostanie uporządkowane ASCENDING (chyba że wyraźnie określono inaczej).

W przypadku indeksów z pojedynczym polem zawsze będzie to dokładnie 1 wpis ze ścieżką pola równą ścieżce powiązanego pola.

state

enum (State)

Tylko dane wyjściowe. Stan obsługi indeksu.

Pole indeksu

Pole w indeksie. Pole PolePath określa, które pole jest indeksowane, a pole value_mode opisuje sposób indeksowania wartości pola.

Zapis JSON
{
  "fieldPath": string,

  // Union field value_mode can be only one of the following:
  "order": enum (Order),
  "arrayConfig": enum (ArrayConfig),
  "vectorConfig": {
    object (VectorConfig)
  }
  // End of list of possible types for union field value_mode.
}
Pola
fieldPath

string

Może być wartością name. W przypadku indeksów z pojedynczym polem wartość ta musi być zgodna z nazwą pola lub może zostać pominięty.

Pole sumy value_mode. Sposób indeksowania wartości pola. value_mode może mieć tylko jedną z tych wartości:
order

enum (Order)

Wskazuje, że to pole obsługuje porządkowanie według określonej kolejności lub porównywanie przy użyciu znaków =, !=, <, <=, >, >=.

arrayConfig

enum (ArrayConfig)

Wskazuje, że to pole obsługuje operacje na arrayValue.

vectorConfig

object (VectorConfig)

Wskazuje, że to pole obsługuje najbliższych sąsiadów i operacje na odległości na wektorze.

Konfiguracja wektora

Konfiguracja indeksu do obsługi operacji wyszukiwania wektorowego

Zapis JSON
{
  "dimension": integer,

  // Union field type can be only one of the following:
  "flat": {
    object (FlatIndex)
  }
  // End of list of possible types for union field type.
}
Pola
dimension

integer

Wymagane. Wymiar wektora, do którego ma zastosowanie ta konfiguracja.

Powstały indeks będzie zawierać tylko wektory tego wymiaru i można go użyć do wyszukiwania wektorowego z tym samym wymiarem.

Pole sumy type. Typ używanego indeksu. type może mieć tylko jedną z tych wartości:
flat

object (FlatIndex)

Wskazuje, że indeks wektorów jest płaski.

Indeks płaski

Ten typ nie zawiera pól.

Indeks, który przechowuje wektory w płaskiej strukturze danych i obsługuje dokładne wyszukiwanie.

TtlConfigDelta

Informacje o zmianie konfiguracji TTL.

Zapis JSON
{
  "changeType": enum (ChangeType)
}
Pola
changeType

enum (ChangeType)

Określa, jak zmienia się konfiguracja TTL.