Google CloudSQL MySQL Execute Action

Action that runs a MySQL command on a CloudSQL MySQL instance.

The action can be used whenever you want to run a MySQL command before or after a data pipeline. For example, you might want to run a SQL update command on a database before the pipeline source pulls data from tables.

Configuration

Property

Macro Enabled?

Version Introduced

Description

Property

Macro Enabled?

Version Introduced

Description

Driver Name

No

 

Required. Name of the JDBC driver to use.

Default is cloudsql-mysql.

Database

Yes
(6.9.0/1.10.5)

 

Required. MySQL database name.

Username

Yes

 

Optional. User identity for connecting to the specified database.

Password

Yes

 

Optional. Password to use to connect to the specified database.

CloudSQL Instance Type

No

 

Optional. Whether the CloudSQL instance to connect to is private or public.

Default is Public.

Connection Name

Yes
(6.9.0/1.10.5)

 

Required. The CloudSQL instance to connect to in the format <PROJECT_ID>:<REGION>:<INSTANCE_NAME>. Can be found in the instance overview page.

Port

Yes

6.9.0/1.10.5

Optional. Port that MySQL is running on.

Default is 3306.

Database Command

Yes

 

Required. Database command to execute.

Connection Timeout

No

 

Optional. The timeout value (in seconds) used for socket connect operations. If connecting to the server takes longer than this value, the connection is broken. A value of 0 means that it is disabled.

Default is 10.

Connection Arguments

Yes

 

Optional. A list of arbitrary string key/value pairs as connection arguments. These arguments will be passed to the JDBC driver as connection arguments for JDBC drivers that may need additional configurations.

Examples

Connecting to a public CloudSQL MySQL instance

Suppose you want to execute a query against a CloudSQL MySQL database named “prod”, as “root” user with “root” password (Get the latest version of the CloudSQL socket factory jar with driver and dependencies here, and then configure plugin with:

Property

Value

Property

Value

Driver Name

cloudsql-mysql

Database

prod

Username

root

Password

root

CloudSQL Instance Type

Public

Connection Name

[PROJECT_ID]:[REGION]:[INSTANCE_NAME]

Database Command

UPDATE table_name SET price = 20 WHERE ID = 6

Connecting to a private CloudSQL MySQL instance

If you want to connect to a private CloudSQL MySQL instance, create a Compute Engine VM that runs the CloudSQL Proxy docker image using the following command:

# Set the environment variables export PROJECT=[project_id] export REGION=[vm-region] export ZONE=`gcloud compute zones list --filter="name=${REGION}" --limit 1 --uri --project=${PROJECT}| sed 's/.*\///'` export SUBNET=[vpc-subnet-name] export NAME=[gce-vm-name] export MYSQL_CONN=[mysql-instance-connection-name] # Create a Compute Engine VM gcloud beta compute --project=${PROJECT_ID} instances create ${INSTANCE_NAME} --zone=${ZONE} --machine-type=g1-small --subnet=${SUBNE} --no-address --metadata=startup-script="docker run -d -p 0.0.0.0:3306:3306 gcr.io/cloudsql-docker/gce-proxy:1.16 /cloud_sql_proxy -instances=${MYSQL_CONNECTION_NAME}=tcp:0.0.0.0:3306" --maintenance-policy=MIGRATE --scopes=https://www.googleapis.com/auth/cloud-platform --image=cos-69-10895-385-0 --image-project=cos-cloud

Optionally, you can promote the internal IP address of the VM running the Proxy image to a static IP using:

# Get the VM internal IP export IP=`gcloud compute instances describe ${NAME} --zone ${ZONE} | grep "networkIP" | awk '{print $2}'` # Promote the VM internal IP to static IP gcloud compute addresses create mysql-proxy --addresses ${IP} --region ${REGION} --subnet ${SUBNET}

Get the latest version of the CloudSQL socket factory jar with driver and dependencies from the Hub, and then configure the plugin with:

Property

Value

Property

Value

Driver Name

cloudsql-mysql

Database

prod

Username

root

Password

root

CloudSQL Instance Type

Private

Connection Name

[PROJECT_ID]:[REGION]:[INSTANCE_NAME]

Database Command

UPDATE table_name SET price = 20 WHERE ID = 6



Created in 2020 by Google Inc.