FieldOperationMetadata

Metadane wyników dla zapytania google.longrunning.Operation 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)

Godzina rozpoczęcia tej operacji.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC 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. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC 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órym działa ta operacja. Na przykład: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object (IndexConfigDelta)

Lista elementów IndexConfigDelta, która opisuje cel 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, jak zmienia się indeks.

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. Ta nazwa indeksów złożonych będzie miała postać: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} W przypadku indeksów pojedynczych pól to pole będzie puste.

queryScope

enum (QueryScope)

Indeksy o określonym zakresie zapytania kolekcji umożliwiają wysyłanie zapytań do kolekcji, która jest podrzędna względem określonego dokumentu, określona w czasie wykonywania zapytania i o tym samym identyfikatorze kolekcji.

Indeksy z określonym zakresem zapytania grupy kolekcji zezwalają na wysyłanie zapytań do 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 wymaga to od 2 do 100 pól. Ostatni wpis w polu zawsze dotyczy ścieżki pola __name__. Jeśli podczas tworzenia pola __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 indeksu złożonego nie jest kierunkowe, pole __name__ ma kolejność ASCENDING (chyba że wyraźnie określono inaczej).

W przypadku indeksów pojedynczych pól będzie to zawsze 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.

IndexField

Pole w indeksie. Pole fieldPath opisuje, które pole jest indeksowane, a pole value_mode określa 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 to być nazwa. W przypadku indeksów pojedynczych pól wartość musi być zgodna z nazwą pola lub może zostać pominięte.

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

enum (Order)

Wskazuje, że to pole umożliwia 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 s.

vectorConfig

object (VectorConfig)

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

VectorConfig

Konfiguracja indeksu do obsługi operacji wyszukiwania wektorowych

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 wektorowy, którego dotyczy ta konfiguracja.

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

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

object (FlatIndex)

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

FlatIndex

Ten typ nie ma żadnych pól.

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

TtlConfigDelta

Informacje o zmianie konfiguracji TTL.

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

enum (ChangeType)

Określa, jak zmienia się konfiguracja TTL.