索引
FirestoreAdmin
(介面)CreateIndexRequest
(訊息)DeleteIndexRequest
(訊息)ExportDocumentsMetadata
(訊息)ExportDocumentsRequest
(訊息)ExportDocumentsResponse
(訊息)Field
(訊息)Field.IndexConfig
(訊息)FieldOperationMetadata
(訊息)FieldOperationMetadata.IndexConfigDelta
(訊息)FieldOperationMetadata.IndexConfigDelta.ChangeType
(列舉)GetFieldRequest
(訊息)GetIndexRequest
(訊息)ImportDocumentsMetadata
(訊息)ImportDocumentsRequest
(訊息)Index
(訊息)Index.IndexField
(訊息)Index.IndexField.ArrayConfig
(列舉)Index.IndexField.Order
(列舉)Index.QueryScope
(列舉)Index.State
(列舉)IndexOperationMetadata
(訊息)ListFieldsRequest
(訊息)ListFieldsResponse
(訊息)ListIndexesRequest
(訊息)ListIndexesResponse
(訊息)OperationState
(列舉)Progress
(訊息)UpdateFieldRequest
(訊息)
FirestoreAdmin
作業是由服務 FirestoreAdmin
建立,但可透過服務 google.longrunning.Operations
存取。
CreateIndex |
---|
建立複合式索引。如此會傳回
|
DeleteIndex |
---|
刪除複合式索引。
|
ExportDocuments |
---|
這個外掛程式能將 Google Cloud Firestore 中所有或部分文件的副本匯出至其他儲存系統,例如 Google Cloud Storage。近期對文件所做的更新可能不會反映在匯出檔案中。匯出作業會在背景中執行,您可以透過已建立的 Operation 資源來監控及管理進度。只有在相關作業完成後,才能使用匯出結果。如在匯出作業完成前取消,部分資料可能仍會留在 Google Cloud Storage 中。
|
GetField |
---|
取得欄位的中繼資料和設定。
|
GetIndex |
---|
取得複合式索引。
|
ImportDocuments |
---|
這個外掛程式能將文件匯入 Google Cloud Firestore。名稱相同的現有文件會遭到覆寫。匯入作業會在背景中執行,您可以透過已建立的 Operation 資源來監控及管理進度。如果已取消 ImportDocuments 作業,可能是部分資料已匯入 Cloud Firestore。
|
ListFields |
---|
列出這個資料庫的欄位設定和中繼資料。 目前
|
ListIndexes |
---|
列出複合式索引。
|
UpdateField |
---|
更新欄位設定。目前欄位更新僅適用於單一欄位索引設定。不過,對 這個呼叫會傳回 若要設定資料庫的預設欄位設定,請使用特殊的
|
CreateIndexRequest
欄位 | |
---|---|
parent |
|
index |
要建立的複合式索引。 |
DeleteIndexRequest
欄位 | |
---|---|
name |
|
ExportDocumentsMetadata
「FirestoreAdmin.ExportDocuments
」的「google.longrunning.Operation
」搜尋結果的中繼資料。
欄位 | |
---|---|
start_time |
這項作業的開始時間。 |
end_time |
這項作業完成的時間。如果作業仍在進行中,系統會取消設定。 |
operation_state |
匯出作業的狀態。 |
progress_documents |
這項作業的進度 (在文件中)。 |
progress_bytes |
這項作業的進度 (以位元組為單位)。 |
collection_ids[] |
要匯出的集合 ID。 |
output_uri_prefix |
實體匯出目標位置。 |
ExportDocumentsRequest
欄位 | |
---|---|
name |
要匯出的資料庫。格式應為 |
collection_ids[] |
要匯出的集合 ID。「未指定」:表示所有集合。 |
output_uri_prefix |
輸出 URI。目前僅支援以下格式的 Google Cloud Storage URI: |
ExportDocumentsResponse
系統會透過 google.longrunning.Operation
回應欄位傳回。
欄位 | |
---|---|
output_uri_prefix |
輸出檔案的位置。您可使用這組憑證,在作業成功完成後開始匯入 Cloud Firestore (這項專案或其他專案)。 |
廣闊
代表資料庫中的單一欄位。
欄位是按「集合群組」分類,代表資料庫中具備相同 ID 的所有集合。
欄位 | |
---|---|
name |
欄位路徑可以是簡單的欄位名稱,例如 欄位路徑可以使用 範例:(注意:這裡的註解是以 Markdown 語法撰寫,因此還有一個倒引號來代表程式碼區塊) 特殊的 |
index_config |
這個欄位的索引設定。如未設定,欄位索引功能會還原為 |
IndexConfig
這個欄位的索引設定。
欄位 | |
---|---|
indexes[] |
這個欄位支援的索引。 |
uses_ancestor_config |
僅供輸出。如果為 true, |
ancestor_field |
僅供輸出。指定已設定這個欄位索引設定時所用 |
reverting |
僅輸出為 true 時, |
FieldOperationMetadata
「FirestoreAdmin.UpdateField
」的「google.longrunning.Operation
」搜尋結果的中繼資料。
欄位 | |
---|---|
start_time |
這項作業的開始時間。 |
end_time |
這項作業完成的時間。如果作業仍在進行中,系統會取消設定。 |
field |
這項作業所執行的欄位資源。例如: |
index_config_deltas[] |
|
state |
作業的狀態。 |
document_progress |
這項作業的進度 (在文件中)。 |
bytes_progress |
這項作業的進度 (以位元組為單位)。 |
IndexConfigDelta
索引設定變更的相關資訊。
欄位 | |
---|---|
change_type |
指定索引變更方式。 |
index |
正在變更的索引。 |
ChangeType
指定索引變更方式。
列舉 | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
未指定或變更類型。 |
ADD |
正在新增單一欄位索引。 |
REMOVE |
正在移除單一欄位索引。 |
GetFieldRequest
欄位 | |
---|---|
name |
|
GetIndexRequest
欄位 | |
---|---|
name |
|
ImportDocumentsMetadata
「FirestoreAdmin.ImportDocuments
」的「google.longrunning.Operation
」搜尋結果的中繼資料。
欄位 | |
---|---|
start_time |
這項作業的開始時間。 |
end_time |
這項作業完成的時間。如果作業仍在進行中,系統會取消設定。 |
operation_state |
匯入作業的狀態。 |
progress_documents |
這項作業的進度 (在文件中)。 |
progress_bytes |
這項作業的進度 (以位元組為單位)。 |
collection_ids[] |
要匯入的集合 ID。 |
input_uri_prefix |
匯入文件的位置。 |
ImportDocumentsRequest
欄位 | |
---|---|
name |
要匯入的資料庫。格式應為 |
collection_ids[] |
要匯入的集合 ID。「未指定」表示匯入作業中的所有集合。 |
input_uri_prefix |
匯出檔案的位置。這個值必須與已成功匯出的 ExportDocumentsResponse 的 output_uri_prefix。請參閱: |
索引
Cloud Firestore 索引可讓您對資料庫中的文件進行簡單複雜的查詢。
欄位 | |
---|---|
name |
僅供輸出。這個索引的伺服器定義名稱。複合式索引的名稱格式如下: |
query_scope |
如果索引已指定集合查詢範圍,您就能查詢特定文件 (在查詢時指定),且集合 ID 相同的集合 ID 的集合。 如果索引已指定集合群組查詢範圍,則可查詢所有集合,這些集合皆來自於查詢時指定的特定文件,且集合 ID 與此索引相同。 |
fields[] |
這個索引支援的欄位。 如果是複合式索引,這個值一律為 2 個以上的欄位。最後一個欄位項目一律適用於欄位路徑 如果是單一欄位索引,則一律為一個項目,且欄位路徑等於關聯欄位的欄位路徑。 |
state |
僅供輸出。索引的服務狀態。 |
IndexField
索引中的欄位。field_path 說明要建立索引的欄位,「value_mode」則說明系統如何為欄位值建立索引。
欄位 | |
---|---|
field_path |
可以是 name。如果是單一欄位索引,這個值必須與欄位名稱相符,否則可省略。 |
聯集欄位 value_mode 。欄位值如何建立索引。value_mode 只能是下列其中一項: |
|
order |
表示這個欄位支援依指定順序排序,或使用 =、<、<=、>、>= 來比較。 |
array_config |
表示這個欄位支援 |
ArrayConfig
支援的陣列值設定。
列舉 | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
索引不支援額外的陣列查詢。 |
CONTAINS |
索引支援陣列包含查詢。 |
訂單
支援的順序。
列舉 | |
---|---|
ORDER_UNSPECIFIED |
未指定順序。選項無效。 |
ASCENDING |
欄位會依欄位值遞增排序。 |
DESCENDING |
欄位會依照欄位值遞減排序。 |
QueryScope
查詢範圍定義查詢執行的範圍。這項資訊是在 StructuredQuery 的 from
欄位中指定。
列舉 | |
---|---|
QUERY_SCOPE_UNSPECIFIED |
未指定查詢範圍。選項無效。 |
COLLECTION |
如果索引已指定集合查詢範圍,您就能查詢特定文件的子集合 (查詢時已指定),且該集合的集合 ID 是由索引指定。 |
COLLECTION_GROUP |
如果索引的集合群組查詢範圍已指定,您就能針對索引指定集合 ID 的所有集合執行查詢。 |
狀態
索引的狀態。建立索引時,索引會處於 CREATING
狀態。如果索引建立成功,則會轉換為 READY
狀態。如果索引建立作業發生問題,索引會轉換為 NEEDS_REPAIR
狀態。
列舉 | |
---|---|
STATE_UNSPECIFIED |
未指定狀態。 |
CREATING |
正在建立索引,索引有一個正在執行的長時間執行的作業。系統會在寫入文件時更新索引。部分索引資料可能存在。 |
READY |
索引已可供使用。系統會在寫入文件時更新索引。索引會從所有套用索引的已儲存文件中完整填入。 |
NEEDS_REPAIR |
已建立索引,但發生錯誤。索引沒有正在執行的長時間執行作業,且最近結束的長時間執行作業失敗。寫入文件時,索引不會更新。部分索引資料可能存在。請使用 google.longrunning.Operations API 來判斷為何上次嘗試建立這個索引的作業失敗,然後重新建立索引。 |
IndexOperationMetadata
「FirestoreAdmin.CreateIndex
」的「google.longrunning.Operation
」搜尋結果的中繼資料。
欄位 | |
---|---|
start_time |
這項作業的開始時間。 |
end_time |
這項作業完成的時間。如果作業仍在進行中,系統會取消設定。 |
index |
這項作業執行的索引資源。例如: |
state |
作業的狀態。 |
progress_documents |
這項作業的進度 (在文件中)。 |
progress_bytes |
這項作業的進度 (以位元組為單位)。 |
ListFieldsRequest
欄位 | |
---|---|
parent |
|
filter |
要套用至清單結果的篩選器。目前 |
page_size |
要傳回的結果數量。 |
page_token |
從上次呼叫 |
ListFieldsResponse
欄位 | |
---|---|
fields[] |
要求的欄位。 |
next_page_token |
可用來要求另一頁結果的網頁權杖。如果留空,表示這是最後一頁。 |
ListIndexesRequest
欄位 | |
---|---|
parent |
|
filter |
要套用至清單結果的篩選器。 |
page_size |
要傳回的結果數量。 |
page_token |
從上次呼叫 |
ListIndexesResponse
欄位 | |
---|---|
indexes[] |
要求的索引。 |
next_page_token |
可用來要求另一頁結果的網頁權杖。如果留空,表示這是最後一頁。 |
OperationState
說明作業的狀態。
列舉 | |
---|---|
OPERATION_STATE_UNSPECIFIED |
未指明 |
INITIALIZING |
正在準備處理要求。 |
PROCESSING |
正在處理要求。 |
CANCELLING |
使用者呼叫 google.longrunning.Operations.CancelOperation 後,系統便會取消要求。 |
FINALIZING |
要求已處理完畢,並正在最終化階段。 |
SUCCESSFUL |
要求已順利完成。 |
FAILED |
要求已處理完畢,但發生錯誤。 |
CANCELLED |
使用者呼叫 google.longrunning.Operations.CancelOperation 後,系統隨即會取消要求。 |
進度
說明作業進度。工作單位是通用的,必須根據 Progress
的使用位置進行解譯。
欄位 | |
---|---|
estimated_work |
預估的工作量。 |
completed_work |
已完成的工作量。 |
UpdateFieldRequest
欄位 | |
---|---|
field |
要更新的欄位。 |
update_mask |
相對於欄位的遮罩。如有指定,系統只會更新 欄位中的 field_mask 指定的設定。 |