CloudSQLInstancePatchOperator

Google

Updates settings of a Cloud SQL instance.

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

bodyRequiredBody required by the Cloud SQL patch API, as described in https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/instances/patch#request-body
instanceRequiredCloud SQL instance ID. This does not include the project ID.
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).
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

Updates settings of a Cloud SQL instance.

Caution: This is a partial update, so only included values for the settings will be updated.

In the request body, supply the relevant portions of an instance resource, according to the rules of patch semantics. https://cloud.google.com/sql/docs/mysql/admin-api/how-tos/performance#patch

See also

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

Was this page helpful?