Method: projects.databases.importDocuments

將文件匯入 Google Cloud Firestore。名稱相同的現有文件將遭到覆寫。匯入作業會在背景中進行，並透過建立的 Operation 資源監控及管理其進度。如果資料庫.importDocuments 作業遭到取消，可能是因為部分資料已匯入 Cloud Firestore。

HTTP 要求

POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:importDocuments

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

執行個體類型，要匯入的目標資料庫。格式應該為：projects/{projectId}/databases/{databaseId}。

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "collectionIds": [
    string
  ],
  "inputUriPrefix": string,
  "namespaceIds": [
    string
  ]
}
欄位
collectionIds[]

string

要匯入的集合 ID。未指定表示匯入項目中包含的所有集合。
inputUriPrefix

string

匯出檔案的位置。這必須符合已成功完成的匯出項目 ExportUriPrefix。請參閱：google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix。
namespaceIds[]

string

空白清單代表所有命名空間。對於不使用命名空間的資料庫，建議您採用這種方式。

空字串元素代表預設命名空間。如果資料庫有資料位於非預設命名空間，但不想納入資料，則應使用此選項。這份清單中的每個命名空間均不得重複。

回應主體

如果成功，回應主體會包含 Operation 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱驗證總覽一文。