Method: projects.databases.importDocuments

将文档导入 Google Cloud Firestore。名称相同的现有文档会被覆盖。导入操作在后台进行,您可以通过创建的 Operation 资源来监控和管理导入进度。如果 Databases.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

导出文件的位置。此前缀必须与成功完成的导出操作的 ExportDocumentsResponse 的 outputUriPrefix 相匹配。请参阅: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

如需了解详情,请参阅身份验证概览