Connect to Cloud SQL for MySQL from your local computer
Learn how to deploy a sample app on your Linux, macOS, or Windows-based local computer connected to a MySQL instance by using the Google Cloud console and a client application.
Assuming that you complete all the steps in a timely manner, the resources created in this quickstart typically cost less than one dollar (USD).
Before you begin
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud APIs necessary to run a Cloud SQL sample app on your local computer.
Console
Click the Enable APIs button to enable the APIs required for this quickstart.
This enables the following APIs:
- Cloud SQL Admin API
- IAM API
gcloud
Install the gcloud CLI which provides command-line access to your Google Cloud resources. The gcloud CLI is used to run the
gcloud CLI
commands presented throughout this quickstart. All the commands are formatted to be run in a Linux/macOS terminal or in Windows Powershell.Open the terminal and run the following
gcloud
command:gcloud services enable sqladmin.googleapis.com iam.googleapis.com
This command enables the following APIs:
- Cloud SQL Admin API
- IAM API
Set up Cloud SQL
Create a Cloud SQL instance
Console
Create an instance with a public IP address
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Click Create Instance.
- Click Choose MySQL.
- Enter
quickstart-instance
for Instance ID. - Enter a password for the root user. Save this password for future use.
- Click the Single zone option for Choose region and zonal availability.
- Click and expand the Show Configuration Options section.
- In the Machine Type drop-down menu, select Lightweight.
Click Create Instance and wait until the instance initializes and starts.
gcloud
Create an instance with a public IP address
Before running the gcloud
sql instances create
command as follows, replace DB_ROOT_PASSWORD with the password of your database user.
Optionally, modify the values for the following parameters:
- --database_version: The database engine type and version. If left unspecified, the API default is used. See the gcloud database versions documentation to see the currently available versions.
- --cpu: The number of cores to set in the machine.
- --memory: Whole number value indicating how much memory to set in the machine. A size unit should be provided (for example, 3072MB or 9GB). If no units are specified, GB is assumed.
- --region: Regional location of the instance
(for example asia-east1, us-east1). If left unspecified, the default
us-central
is used. See the full list of regions.
Run the gcloud
sql instances create
command to create a Cloud SQL instance.
gcloud sql instances create quickstart-instance --database-version=MYSQL_8_0 --cpu=1 --memory=4GB --region=us-central1 --root-password=DB_ROOT_PASSWORD
Create a database
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Select
quickstart-instance
. - Open the Databases tab.
- Click Create database.
- In the Create a database dialog box, enter
quickstart_db
as the name of the database, and optionally the character set and collation. - Click Create.
gcloud
Run the gcloud
sql databases create
command to create a database.
gcloud sql databases create quickstart_db --instance=quickstart-instance
Create a user
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Select Users from the SQL navigation menu.
- Click Add user account.
- In the Add a user account to instance instance_name page,
add the following information:
- Username: Set to
quickstart-user
- Password: Specify a password for your database user. Make a note of this for use in a later step of this quickstart.
- In the Host name section, the default is Allow any host,
which means that the user can connect from any IP address.
Optionally, select Restrict host by IP address or address range and enter an IP address or address range in the Host section. The user can then connect only from the IP address or addresses specified.
- Username: Set to
- Click Add.
gcloud
Replace the following:
- PASSWORD with a password for your database user. Make a note of this for use in a later step of this quickstart.
Run the gcloud sql users create
command to create the user.
gcloud sql users create quickstart-user --instance=quickstart-instance --password=PASSWORD
User name length limits are the same for Cloud SQL as for on-premises MySQL; 32 characters for MySQL 8.0 and later, 16 characters for earlier versions.
Set up a service account
Console
Create a service account
- In the Google Cloud console, go to the Create service account page.
- Select a Google Cloud project.
- Enter a
quickstart-service-account
as the service account name. - Optional: Enter a description of the service account.
- Click Create and continue and continue to the next step.
- Choose the Cloud SQL Client role to grant to the service account on the project.
- Click Continue.
- Click Done to finish creating the service account.
Create and download the service account key file
- In the Google Cloud console, go to the Service accounts page.
- Select a project.
- Click the email address of the
quickstart-service-account
service account that you want to create a key for. - Click the Keys tab.
- Click the Add key drop-down menu, then select Create new key.
- Select JSON as the Key type and click Create.
Clicking Create downloads a service account key file. After you download the key file, you cannot download it again.
Make sure to store the key file securely, because it can be used to authenticate as your service account. You can move and rename this file however you would like.
gcloud
Create a service account
- To create the service account, run the
gcloud iam service-accounts create
command: DESCRIPTION
: An optional description of the service account- To grant your service account the Cloud SQL Client role on your project, run the
gcloud projects add-iam-policy-binding
command. Replace PROJECT_ID with your Google Cloud project ID:gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:quickstart-service-account@PROJECT_ID.iam.gserviceaccount.com" --role="roles/cloudsql.client"
gcloud iam service-accounts create quickstart-service-account --description="DESCRIPTION" --display-name="quickstart-service-account"
Replace the following value:
Create and download the service account key file
To use the service account you just created from your local computer you need a service account key file to
authenticate the sample application as the service account. To create and download the service account key file, run the
gcloud iam service-accounts keys create
command:
gcloud iam service-accounts keys create KEY_FILE --iam-account=quickstart-service-account@PROJECT_ID.iam.gserviceaccount.com
Replace the following values:
-
KEY_FILE
: The path to a new output file for the private key — for example,~/sa-private-key.json
. -
PROJECT_ID
: Your Google Cloud project ID.
The service account key file is now downloaded to your local computer. After you download the key file, you cannot download it again.
Make sure to store the key file securely, because anyone can use it to authenticate as your service account. You can move and rename this file however you would like.
Setup development environment for programming language
Set up your local computer's development environment for your preferred programming language.
Go
Complete the following steps to set up your development environment to run the Go sample app.
- Go to the setup guide for a Go development environment.
- Complete the instructions in the Install Go section.
Java
Complete the following steps to set up your development environment to run the Java sample app.
- Go to the setup guide for a Java development environment.
- Complete the instructions in the Install a JDK (Java Development Kit) section.
- Complete the instructions in the Install a build automation tool to set up Apache Maven.
Node.js
Complete the following steps to set up your development environment to run the Node.js sample app.
- Go to setup guide for a Node.js development environment.
- Complete the instructions in the Installing Node.js and npm section.
Python
Complete the following steps to set up your development environment to run the Python sample app.
- Go to setup guide for a Python development environment.
- Complete the instructions in the Installing Python section.
Install Git
Install Git, an open source version control system.
Clone a sample app
Clone a sample app to your local computer using the git clone
command.
Go
Run the following commands to clone the Go sample app to your local computer and change directory to the directory containing the sample app.
-
Clone the sample app.
git clone https://github.com/GoogleCloudPlatform/golang-samples
-
Change directory to the directory containing the sample app.
cd golang-samples/cloudsql/mysql/database-sql
Java
Run the following commands to clone the Java sample app to your local computer and change directory to the directory containing the sample app.
-
Clone the sample app.
git clone https://github.com/GoogleCloudPlatform/java-docs-samples
-
Change directory to the directory containing the sample app.
cd java-docs-samples/cloud-sql/mysql/servlet
Node.js
Run the following commands to clone the Node.js sample app to your local computer and change directory to the directory containing the sample app.
-
Clone the sample app.
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
-
Change directory to the directory containing the sample app.
cd nodejs-docs-samples/cloud-sql/mysql/mysql
Python
Run the following commands to clone the Python sample app to your local computer and change directory to the directory containing the sample app.
-
Clone the sample app.
git clone https://github.com/GoogleCloudPlatform/python-docs-samples
-
Change directory to the directory containing the sample app.
cd python-docs-samples/cloud-sql/mysql/sqlalchemy
Configure and run sample app
Configure and run the sample app.
Clean up
To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Select the
quickstart-instance
instance to open the Instance details page. - In the icon bar at the top of the page, click Delete.
- In the Delete instance dialog box, type
quickstart-instance
, and then click Delete to delete the instance.
Optional cleanup steps
If you're not using the Cloud SQL client role that you assigned to the
quickstart-service-account
service account, you can remove it.
-
In the Google Cloud console, go to the IAM page.
- Click the edit icon (which looks like a pencil) for the IAM account named quickstart-service-account.
- Delete the Cloud SQL client role.
- Click Save.
If you're not using the APIs that were enabled as part of this quickstart, you can disable them.
- APIs that were enabled within this quickstart:
- Cloud SQL Admin API
- Identity and Access Management API
In the Google Cloud console, go to the APIs page.
Select any API that you would like to disable and then click the Disable API button.
What's next
Based on your needs, you can learn more about creating Cloud SQL instances.You also can learn about creating MySQL users and databases for your Cloud SQL instance.
For more information about pricing, see Cloud SQL for MySQL pricing.
Learn more about:
- Configuring your Cloud SQL instance with a public IP address.
- Configuring your Cloud SQL instance with a private IP address.
Additionally, you can learn about connecting to a Cloud SQL instance from other Google Cloud applications: