REST Resource: projects.databases.collectionGroups.indexes

{
  "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)

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