Method: googleapis.firestore.v1beta1.projects.databases.exportDocuments

Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

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 export. Should be of the form: projects/{project_id}/databases/{database_id}.
body	object (GoogleFirestoreAdminV1beta1ExportDocumentsRequest) 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

- exportDocuments:
    call: googleapis.firestore.v1beta1.projects.databases.exportDocuments
    args:
        name: ...
        body:
            collectionIds: ...
            outputUriPrefix: ...
    result: exportDocumentsResult

JSON

[
  {
    "exportDocuments": {
      "call": "googleapis.firestore.v1beta1.projects.databases.exportDocuments",
      "args": {
        "name": "...",
        "body": {
          "collectionIds": "...",
          "outputUriPrefix": "..."
        }
      },
      "result": "exportDocumentsResult"
    }
  }
]