REST Resource: projects.databases.collectionGroups.indexes

資源：Index

Cloud Firestore 索引可讓您對資料庫中的文件進行簡單複雜的查詢。

JSON 表示法 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
欄位
name

string

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

enum (QueryScope)

如果索引已指定集合查詢範圍，您就能查詢特定文件 (在查詢時指定)，且集合 ID 相同的集合 ID 的集合。

如果索引已指定集合群組查詢範圍，則可查詢所有集合，這些集合皆來自於查詢時指定的特定文件，且集合 ID 與此索引相同。
fields[]

object (IndexField)

這個索引支援的欄位。

如果是複合式索引，這個值一律為 2 個以上的欄位。最後一個欄位項目一律適用於欄位路徑 __name__。如果在建立時未指定 __name__ 做為最後一個欄位，系統會自動新增該欄位，方向與最後一個欄位定義的方向相同。如果複合式索引中的最後一個欄位沒有方向性，則 __name__ 會排序 ASCENDING (除非明確指定)。

如果是單一欄位索引，則一律為一個項目，且欄位路徑等於關聯欄位的欄位路徑。
state

enum (State)

僅供輸出。索引的服務狀態。

方法

create

 建立複合式索引。

delete

 刪除複合式索引。

get

 取得複合式索引。

list

 列出複合式索引。