Cloud SQL for MySQL

Cloud SQL for MySQL is a fully-managed database service for MySQL.

About

Cloud SQL for MySQL is a fully-managed database service that helps you set up, maintain, manage, and administer your MySQL relational databases on Google Cloud Platform.

If you are new to Cloud SQL for MySQL, you can try creating and connecting to a database by following these instructions.

Available Tools

Pre-built Configurations

Requirements

IAM Permissions

By default, this source uses the Cloud SQL Go Connector to authorize and establish mTLS connections to your Cloud SQL instance. The Go connector uses your Application Default Credentials (ADC) to authorize your connection to Cloud SQL.

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the following IAM roles (or corresponding permissions):

  • roles/cloudsql.client

Tip

If you are connecting from Compute Engine, make sure your VM also has the proper scope to connect using the Cloud SQL Admin API.

Networking

Cloud SQL supports connecting over both from external networks via the internet (public IP), and internal networks (private IP). For more information on choosing between the two options, see the Cloud SQL page Connection overview.

You can configure the ipType parameter in your source configuration to public or private to match your cluster’s configuration. Regardless of which you choose, all connections use IAM-based authorization and are encrypted with mTLS.

Authentication

This source supports both password-based authentication and IAM authentication (using your Application Default Credentials).

Standard Authentication

To connect using user/password, create a MySQL user and input your credentials in the user and password fields.

user: ${USER_NAME} password: ${PASSWORD}

IAM Authentication

To connect using IAM authentication:

  1. Prepare your database instance and user following this guide.

  2. You could choose one of the two ways to log in:

    • Specify your IAM email as the user.
    • Leave your user field blank. Toolbox will fetch the ADC automatically and log in using the email associated with it.

  3. Leave the password field blank.

Example

sources:  my-cloud-sql-mysql-source:  kind: cloud-sql-mysql  project: my-project-id  region: us-central1  instance: my-instance  database: my_db  user: ${USER_NAME}  password: ${PASSWORD}  # ipType: "private"

Tip

Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file.

Reference

fieldtyperequireddescription
kindstringtrueMust be “cloud-sql-mysql”.
projectstringtrueId of the GCP project that the cluster was created in (e.g. “my-project-id”).
regionstringtrueName of the GCP region that the cluster was created in (e.g. “us-central1”).
instancestringtrueName of the Cloud SQL instance within the cluster (e.g. “my-instance”).
databasestringtrueName of the MySQL database to connect to (e.g. “my_db”).
userstringfalseName of the MySQL user to connect as (e.g “my-mysql-user”). Defaults to IAM auth using ADC email if unspecified.
passwordstringfalsePassword of the MySQL user (e.g. “my-password”). Defaults to attempting IAM authentication if unspecified.
ipTypestringfalseIP Type of the Cloud SQL instance, must be either public, private, or psc. Default: public.
Last modified December 19, 2025: chore(main): release 0.24.0 (#2162) (f520b4e)