Method: projects.databases.importDocuments

Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an databases.importDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Database to import into. Should be of the form: projects/{projectId}/databases/{databaseId}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "collectionIds": [
    string
  ],
  "inputUriPrefix": string,
  "namespaceIds": [
    string
  ]
}
Fields
collectionIds[]

string

Which collection IDs to import. Unspecified means all collections included in the import. Each collection ID in this list must be unique.
inputUriPrefix

string

Location of the exported files. This must match the outputUriPrefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
namespaceIds[]

string

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.