FieldOperationMetadata

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

enum (ChangeType)

指定索引的變更方式。

object (Index)

正在變更的索引。

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

string

僅供輸出。這個索引的伺服器定義名稱。複合式索引的名稱格式為： projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} 如果是單一欄位索引，此欄位將為空白。

enum (QueryScope)

如果索引設有集合查詢範圍，則可在查詢時指定特定文件子項且集合 ID 相同的集合，對集合執行查詢。

如果索引指定了集合群組查詢範圍，則可在查詢時指定特定文件，且集合 ID 與這個索引相同的所有集合，對這些集合執行查詢。

enum (ApiScope)

這個索引支援的 API 範圍。

object (IndexField)

此索引支援的欄位。

以複合式索引來說，最少需要 2 個欄位，最多 100 個欄位。最後一個欄位項目一律為欄位路徑 __name__。如果在建立時未指定 __name__ 為最後一個欄位，系統會自動新增該欄位，並將該欄位的方向與最後一個定義欄位相同。如果複合式索引的最後一個欄位並非方向性欄位，__name__ 就會排序 ASCENDING (除非已明確指定)。

如為單一欄位索引，這個值一律為一個項目，且欄位路徑會與關聯欄位的欄位路徑相同。

enum (State)

僅供輸出。索引的提供狀態。

{
  "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.
}

string

可以是 name。如為單一欄位索引，這個值必須與欄位名稱相符，否則可能會遭到省略。

enum (Order)

表示這個欄位支援按照指定的順序排序，或使用 =、!=、<、<=、>、>= 進行比較。

enum (ArrayConfig)

表示這個欄位支援對 arrayValue 作業。

object (VectorConfig)

表示這個欄位支援向量上最鄰近的項目和距離運算。

{
  "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.
}

integer

執行個體類型，要套用這項設定的向量維度。

產生的索引只會包含這個維度的向量，並可用於具有相同維度的向量搜尋。

object (FlatIndex)

表示向量索引是平面索引。

{
  "changeType": enum (ChangeType)
}

enum (ChangeType)

指定存留時間設定的異動方式。