「FirestoreAdmin.UpdateField
」中「google.longrunning.Operation
」搜尋結果的中繼資料。
JSON 表示法 |
---|
{ "startTime": string, "endTime": string, "field": string, "indexConfigDeltas": [ { object ( |
欄位 | |
---|---|
startTime |
這項作業開始的時間。 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例: |
endTime |
此作業完成的時間。如果作業仍在進行中,則會未設定。 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例: |
field |
這項作業所執行的欄位資源。例如: |
indexConfigDeltas[] |
|
state |
作業狀態。 |
progressDocuments |
這項作業的進度,以文件中。 |
progressBytes |
這項作業的進度 (以位元組為單位)。 |
ttlConfigDelta |
說明存留時間設定的差異。 |
IndexConfig Delta 值
索引設定變更的相關資訊。
JSON 表示法 |
---|
{ "changeType": enum ( |
欄位 | |
---|---|
changeType |
指定索引的變更方式。 |
index |
正在變更的索引。 |
索引
有了 Cloud Firestore 索引,您就能針對資料庫中的文件進行簡單複雜的查詢。
JSON 表示法 |
---|
{ "name": string, "queryScope": enum ( |
欄位 | |
---|---|
name |
僅供輸出。這個索引的伺服器定義名稱。複合式索引的名稱格式為: |
queryScope |
如果索引設有集合查詢範圍,則可在查詢時指定特定文件子項且集合 ID 相同的集合,對集合執行查詢。 如果索引指定了集合群組查詢範圍,則可在查詢時指定特定文件,且集合 ID 與這個索引相同的所有集合,對這些集合執行查詢。 |
apiScope |
這個索引支援的 API 範圍。 |
fields[] |
此索引支援的欄位。 以複合式索引來說,最少需要 2 個欄位,最多 100 個欄位。最後一個欄位項目一律為欄位路徑 如為單一欄位索引,這個值一律為一個項目,且欄位路徑會與關聯欄位的欄位路徑相同。 |
state |
僅供輸出。索引的提供狀態。 |
索引欄位
索引中的欄位。欄位路徑說明已建立索引的欄位,value_mode 說明欄位值建立索引的方式。
JSON 表示法 |
---|
{ "fieldPath": string, // Union field |
欄位 | |
---|---|
fieldPath |
可以是 name。如為單一欄位索引,這個值必須與欄位名稱相符,否則可能會遭到省略。 |
聯集欄位 value_mode 。欄位值編入索引的方式。value_mode 只能採用下列其中一種設定: |
|
order |
表示這個欄位支援按照指定的順序排序,或使用 =、!=、<、<=、>、>= 進行比較。 |
arrayConfig |
表示這個欄位支援對 |
vectorConfig |
表示這個欄位支援向量上最鄰近的項目和距離運算。 |
VectorConfig
用於支援向量搜尋作業的索引設定
JSON 表示法 |
---|
{ "dimension": integer, // Union field |
欄位 | |
---|---|
dimension |
執行個體類型,要套用這項設定的向量維度。 產生的索引只會包含這個維度的向量,並可用於具有相同維度的向量搜尋。 |
聯集欄位 type 。使用的索引類型。type 只能採用下列其中一種設定: |
|
flat |
表示向量索引是平面索引。 |
平面索引
這個類型沒有任何欄位。
這個索引可將向量儲存在平面資料結構中,並支援全面搜尋。
TtlConfigDelta
存留時間設定變更的相關資訊。
JSON 表示法 |
---|
{
"changeType": enum ( |
欄位 | |
---|---|
changeType |
指定存留時間設定的異動方式。 |