CloudSQLExportInstanceOperator

Google

Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

View on GitHub

Last Updated: Mar. 3, 2023

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

instanceRequiredCloud SQL instance ID. This does not include the project ID.
bodyRequiredThe request body, as described in https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/instances/export#request-body
project_idOptional, Google Cloud Project ID. If set to None or missing, the default project_id from the Google Cloud connection is used.
gcp_conn_idThe connection ID used to connect to Google Cloud.
api_versionAPI version used (e.g. v1beta4).
validate_bodyWhether the body should be validated. Defaults to True.
impersonation_chainOptional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

Documentation

Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

Note: This operator is idempotent. If executed multiple times with the same export file URI, the export file in GCS will simply be overridden.

See also

For more information on how to use this operator, take a look at the guide: CloudSQLExportInstanceOperator

Was this page helpful?