Method: googleapis.firestore.v1.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 ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters
name

string

Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.
body

object (GoogleFirestoreAdminV1ImportDocumentsRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
OperationError If the long-running operation finished unsuccessfully.
ResponseTypeError If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of GoogleLongrunningOperation.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- importDocuments:
    call: googleapis.firestore.v1.projects.databases.importDocuments
    args:
        name: ...
        body:
            collectionIds: ...
            inputUriPrefix: ...
    result: importDocumentsResult

JSON

[
  {
    "importDocuments": {
      "call": "googleapis.firestore.v1.projects.databases.importDocuments",
      "args": {
        "name": "...",
        "body": {
          "collectionIds": "...",
          "inputUriPrefix": "..."
        }
      },
      "result": "importDocumentsResult"
    }
  }
]