資源:Index
索引定義。
JSON 表示法 |
---|
{ "name": string, "collectionId": string, "fields": [ { object ( |
欄位 | |
---|---|
name |
索引的資源名稱。僅供輸出。 |
collectionId |
要套用此索引的集合 ID。這是必填欄位。 |
fields[] |
要建立索引的欄位。 |
state |
索引狀態。僅供輸出。 |
IndexField
索引的欄位。
JSON 表示法 |
---|
{
"fieldPath": string,
"mode": enum ( |
欄位 | |
---|---|
fieldPath |
欄位路徑。必須符合 [google.firestore.v1beta1.Document.fields][fields] 描述的欄位路徑規格。特殊欄位路徑 |
mode |
欄位的模式。 |
方式
模式會決定欄位編入索引的方式。
列舉 | |
---|---|
MODE_UNSPECIFIED |
未指定模式。 |
ASCENDING |
系統會為欄位值建立索引,因此支援以遞增順序排列,也能依 <、>、<=、>= 和 = 進行查詢。 |
DESCENDING |
系統會為欄位值建立索引,因此支援以遞減順序排列,以及依 <、>、<=、>= 和 = 查詢。 |
ARRAY_CONTAINS |
系統會將欄位的陣列值編入索引,以便在使用 ARRAY_CONTAINS 查詢時支援成員資格。 |
狀態
索引的狀態。建立索引時,索引會處於 CREATING
狀態。如果索引建立成功,則會轉換為 READY
狀態。如果無法建立索引,則會轉換為 ERROR
狀態。
列舉 | |
---|---|
STATE_UNSPECIFIED |
未指定狀態。 |
CREATING |
正在建立索引,索引有一個正在執行的長時間執行的作業。系統會在寫入文件時更新索引。部分索引資料可能存在。 |
READY |
索引已可供使用。系統會在寫入文件時更新索引。索引會從所有套用索引的已儲存文件中完整填入。 |
ERROR |
已建立索引,但發生錯誤。索引沒有正在執行的長時間執行作業,且最近結束的長時間執行作業失敗。寫入文件時,索引不會更新。部分索引資料可能存在。 |
方法 |
|
---|---|
|
建立指定的索引。 |
|
刪除索引。 |
|
取得索引。 |
|
列出符合指定篩選條件的索引。 |