REST Resource: projects.databases.indexes

資源：索引

索引定義。

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

string

索引的資源名稱。僅供輸出。
collectionId

string

這個索引適用的集合 ID。必填。
fields[]

object (IndexField)

要建立索引的欄位。
state

enum (State)

索引的狀態。僅供輸出。

索引欄位

索引的欄位。

JSON 表示法 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
欄位
fieldPath

string

欄位路徑。必須符合 [google.firestore.v1beta1.Document.fields][fields] 所描述的欄位路徑規格。特殊欄位路徑 __name__ 可單獨使用，也可在路徑結尾使用。「__type__」只能用在路徑結尾。
mode

enum (Mode)

欄位模式。

模式

模式會決定欄位的索引方式。

列舉
MODE_UNSPECIFIED 未指定模式。
ASCENDING 系統會為欄位值建立索引，藉此支援以遞增順序排序的字母，同時也能使用 <、>、<=、>= 和 = 來查詢。
DESCENDING 系統會為欄位值建立索引，藉此支援以遞減順序排序的字母，同時也能使用 <、>、<=、>= 和 = 進行查詢。
ARRAY_CONTAINS 系統會為欄位陣列值建立索引，以支援使用 ARRAY_CONTAINS 查詢的成員。

狀態

索引的狀態。在建立索引期間，索引會處於 CREATING 狀態。如果索引建立成功，就會轉換為 READY 狀態。如果無法建立索引，該索引會轉換為 ERROR 狀態。

列舉
STATE_UNSPECIFIED 未指定狀態。
CREATING 正在建立索引。索引有一個執行中的長時間執行作業。寫入文件時，索引會更新。可能存在部分索引資料。
READY 索引已可供使用。寫入文件時，索引會更新。索引會完全填入套用該索引的所有已儲存文件。
ERROR 正在建立索引，但發生錯誤。索引沒有執行中的長時間執行作業，且最近完成的長時間執行作業失敗。寫入文件時，索引不會更新。可能存在部分索引資料。

方法

create

 建立指定的索引。

delete

 刪除索引。

get

 取得索引。

list

 列出符合指定篩選器的索引。