Connect to Cloud SQL for MySQL from App Engine flexible environment

Console

1. In the Google Cloud console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

2. Click Create instance.
3. Click Choose MySQL.
4. Make sure that Enterprise Plus is selected as the Cloud SQL edition for your instance.
5. In the Instance ID field, enter quickstart-instance.
6. In the Password field, enter a password for the root user. Save this password for future use.
7. In the Choose region and zonal availability section, select Single zone.
8. Click the Show configuration options menu.
9. Expand the Machine configuration node.
10. From the Machine shapes region, select the 4 vCPU, 32 GB shape.
11. Click Create instance and then wait until the instance initializes and starts.

gcloud

Before running the 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 current available versions.
• --cpu: The number of cores desired in the machine.
• --memory: Whole number value indicating how much memory is desired 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.

Run the gcloud sql instances create command to create a Cloud SQL instance.

gcloudsqlinstancescreatequickstart-instance\ --database-version=MYSQL_8_0\ --cpu=1\ --memory=4GB\ --region=us-central1\ --root-password=DB_ROOT_PASSWORD

Console

Allocate an IP address range and create a private connection to configure private services access for Cloud SQL

1. In the Google Cloud console, go to the VPC networks page.

   Go to VPC networks

2. Select the default VPC network.
3. Select the Private service connection tab.
4. Select the Allocated IP ranges for services tab.
5. Click Allocate IP range.
6. For the Name of the allocated range, specify google-managed-services-default.
7. Select the Automatic option for IP range and specify the prefix length as 16.
8. Click Allocate to create the allocated range.
9. Select the Private connections to services tab for the default VPC network.
10. Click Create connection to create a private connection between your network and a service producer.
11. For the Assigned allocation, select google-managed-services-default.
12. Click Connect to create the connection.

Create an instance with private IP address and SSL enabled

1. In the Google Cloud console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

2. Click Create instance.
3. Click Choose MySQL.
4. Make sure that Enterprise Plus is selected as the Cloud SQL edition for your instance.
5. In the Instance ID field, enter quickstart-instance.
6. In the Password field, enter a password for the root user. Save this password for future use.
7. In the Choose region and zonal availability section, select Single zone.
8. Click the Show configuration options menu.
9. Expand the Machine configuration node.
10. From the Machine shapes region, select the 4 vCPU, 32 GB shape.
11. Expand the Connections node.
12. Clear the Public IP checkbox to create an instance only with a private IP address.
13. Select the Private IP checkbox.
14. From the Network menu, select default.
15. Click Create instance and then wait for the instance to initialize and start.
16. Click Connections.
17. In the Security section, select Allow only SSL connections to enable SSL connections.
18. In the Enable SSL dialog, click Enable and restart and then wait for the instance to restart.

gcloud

Allocate an IP address range and create a private connection to configure private services access for Cloud SQL

1. Run the gcloud compute addresses create command to allocate an IP address range.

   gcloudcomputeaddressescreategoogle-managed-services-default\ --global--purpose=VPC_PEERING--prefix-length=16\ --description="peering range for Google"--network=default

2. Run the gcloud services vpc-peerings connect command to create a private connection to the allocated IP address range. Replace YOUR_PROJECT_ID with your project's project ID.

   gcloudservicesvpc-peeringsconnect--service=servicenetworking.googleapis.com\ --ranges=google-managed-services-default--network=default\ --project=YOUR_PROJECT_ID

Create an instance with private IP address and SSL enabled

1. Before running the 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 current available versions.
• --cpu: The number of cores in the machine.
• --memory: A whole number value indicating how much memory to include in the machine. A size unit can be provided (for example, 3072MB or 9GB). If no units are specified, GB is assumed.
• --region: The regional location of the instance (for example asia-east1, us-east1). If left unspecified, the default us-central1 is used. See the full list of regions.

Run the gcloud sql instances create command to create a Cloud SQL instance with a Private IP address.

gcloudsqlinstancescreatequickstart-instance\ --database-version=MYSQL_8_0\ --cpu=1\ --memory=4GB\ --region=us-central1\ --root-password=DB_ROOT_PASSWORD\ --no-assign-ip\ --network=default

2. Run the gcloud sql instances patch command to enable only allow SSL connections for the instance.

gcloudsqlinstancespatchquickstart-instance--require-ssl

Go

1. In Cloud Shell Editor, open the sample app's source code.

   Open Cloud Shell Editor
2. In the Open in Cloud Shell dialog box, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
3. At the Cloud Shell command prompt, run the following command to activate your project:

   gcloudconfigsetprojectYOUR-PROJECT-ID

4. If an Authorize Cloud Shell dialog box appears, then click Authorize.
5. From the Explorer navigation menu of Cloud Shell Editor, click the expandable node that's the username of your Google Cloud account.
6. Navigate to and open the cloudshell_open/golang-samples/cloudsql/mysql/database-sql/app.flexible.yaml file.
7. Replace the placeholders for the environment variables in the app.flexible.yaml file with the following values:
• <PROJECT-ID> with your project ID.
• <INSTANCE-REGION> with us-central1.
• <INSTANCE-NAME> with quickstart-instance.
• <YOUR_DB_USER_NAME> with quickstart-user.
• <YOUR_DB_PASSWORD> with the password of the quickstart-user that you created in Create a user.
• <YOUR_DB_NAME> with quickstart-db.
8. At the Cloud Shell command prompt, in the cloudshell_open/golang-samples/cloudsql/mysql/database-sql directory, run the following gcloud app deploy command to deploy the sample app to App Engine flexible environment.

gcloudappdeployapp.flexible.yaml

9. When prompted with Do you want to continue?, enter Y.
10. After the actions performed by running the gcloud app deploy command complete, run the gcloud app browse command:

gcloudappbrowse

11. Click the generated link to see the sample app running on App Engine flexible environment. This environment is connected to Cloud SQL.

Java

1. In Cloud Shell Editor, open the sample app's source code.

   Open Cloud Shell Editor
2. In the Open in Cloud Shell dialog box, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
3. At the Cloud Shell command prompt, run the following command to activate your project:

   gcloudconfigsetprojectYOUR-PROJECT-ID

4. If an Authorize Cloud Shell dialog box appears, then click Authorize.
5. From the Explorer navigation menu of Cloud Shell Editor, click the expandable node that's the username of your Google Cloud account.
6. Navigate to and open the cloudshell_open/java-docs-samples/cloud-sql/mysql/servlet/src/main/webapp/WEB-INF/appengine-web.xml file.
7. Replace the placeholders for the environment variables in the appengine-web.xml file with the following values:
• my-project:region:instance with your instance's Connection name that appears on the Cloud SQL instances page in the Google Cloud console.
• my-db-user with quickstart-user.
• my-db-password with the password of the quickstart-user that you created in Create a user.
• my_db with quickstart-db.
8. At the Cloud Shell command prompt, in the cloudshell_open/java-docs-samples/cloud-sql/mysql/servlet directory, run the following Apache Mavenmvn clean package command to deploy the sample app to App Engine flexible environment.

mvncleanpackageappengine:deploy-DskipTests

9. When prompted with Do you want to continue?, enter Y.
10. After the actions performed by running the gcloud app deploy command complete, run the gcloud app browse command:

gcloudappbrowse

11. Click the generated link to see the sample app running on App Engine flexible environment. This environment is connected to Cloud SQL.

Node.js

1. In Cloud Shell Editor, open the sample app's source code.

   Open Cloud Shell Editor
2. In the Open in Cloud Shell dialog box, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
3. At the Cloud Shell command prompt, run the following command to activate your project:

   gcloudconfigsetprojectYOUR-PROJECT-ID

4. If an Authorize Cloud Shell dialog box appears, then click Authorize.
5. From the Explorer navigation menu of Cloud Shell Editor, click the expandable node that's the username of your Google Cloud account.
6. Navigate to and open the cloudshell_open/nodejs-docs-samples/cloud-sql/mysql/mysql/app.flexible.yaml file.
7. Replace the placeholders for the environment variables in the app.flexible.yaml file with the following values:
• <MY-PROJECT> with your project ID.
• <INSTANCE-REGION> with us-central1.
• <INSTANCE-NAME> with quickstart-instance.
• MY_DB_USER with quickstart-user.
• MY_DB_PASSWORD with the password of the quickstart-user that you created in Create a user.
• MY_DATABASE with quickstart-db.
8. At the Cloud Shell command prompt, in the cloudshell_open/nodejs-docs-samples/cloud-sql/mysql/mysql directory, run the following gcloud app deploy command to deploy the sample app to App Engine flexible environment.

gcloudappdeployapp.flexible.yaml

9. When prompted with Do you want to continue?, enter Y.
10. After the actions performed by running the gcloud app deploy command complete, run the gcloud app browse command:

gcloudappbrowse

11. Click the generated link to see the sample app running on App Engine flexible environment. This environment is connected to Cloud SQL.

Python

1. In Cloud Shell Editor, open the sample app's source code.

   Open Cloud Shell Editor
2. In the Open in Cloud Shell dialog box, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
3. At the Cloud Shell command prompt, run the following command to activate your project:

   gcloudconfigsetprojectYOUR-PROJECT-ID

4. If an Authorize Cloud Shell dialog box appears, then click Authorize.
5. From the Explorer navigation menu of Cloud Shell Editor, click the expandable node that's the username of your Google Cloud account.
6. Navigate to and open the cloudshell_open/python-docs-samples/cloud-sql/mysql/sqlalchemy/app.flexible.yaml file.
7. Replace the placeholders for the environment variables in the app.flexible.yaml file with the following values:
• <PROJECT-ID> with your project ID.
• <INSTANCE-REGION> with quickstart-instance.
• <YOUR_DB_USER_NAME> with quickstart-user.
• <YOUR_DB_PASSWORD> with the password of the quickstart-user that you created in Create a user.
• <YOUR_DB_NAME> with quickstart-db.
8. At the Cloud Shell command prompt, in the cloudshell_open/python-docs-samples/cloud-sql/mysql/sqlalchemy directory, run the following gcloud app deploy command to deploy the sample app to App Engine flexible environment.

gcloudappdeployapp.flexible.yaml

9. When prompted with Do you want to continue?, enter Y.
10. After the actions performed by running the gcloud app deploy command complete, run the gcloud app browse command:

gcloudappbrowse

11. Click the generated link to see the sample app running on App Engine flexible environment. This environment is connected to Cloud SQL.

Go

Create and download SSL server and client certificates

1. In the Google Cloud console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

2. Click the quickstart-instance to see its Overview page
3. Click the Connections tab.
4. Under the Security section, click Create client certificate.
5. In the Create a client certificate dialog, enter quickstart-key as the name and click Create.

6. In the New SSL certificate created dialog, click each download link to download the certificates. Then, click Close.

Build a sample app with SSL certificates

1. In Cloud Shell Editor, open the sample app's source code.

   Open Cloud Shell Editor
2. In the Open in Cloud Shell dialog, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
3. At the Cloud Shell command prompt, run the following command to activate your project:

   gcloudconfigsetprojectYOUR-PROJECT-ID

4. If an Authorize Cloud Shell dialog appears, then click Authorize.
5. Upload SSL certs files to the certs folder.
   1. From the Explorer navigation menu of Cloud Shell Editor, navigate to the golang-samples/cloudsql/mysql/database-sql/certs folder.
   2. Right-click the certs folder in Cloud Shell Editor and select Upload Files.
   3. Select following files on your local machine:
   • client-key.pem
   • client-cert.pem
   • server-ca.pem
   4. With the three SSL certificate files selected, click Open to complete the process of uploading the files to Cloud Shell Editor.
6. From the Explorer navigation menu of Cloud Shell Editor, click the expandable node that's the username of your Google Cloud account.
7. Navigate to and open the cloudshell_open/golang-samples/cloudsql/mysql/database-sql/app.flexible.yaml file.
8. Copy and paste the following code into the file, replacing the existing file content:

runtime:custom env:flex env_variables: DB_USER:quickstart-user DB_PASS:YOUR_DB_PASSWORDDB_NAME:quickstart-db DB_PORT:3306INSTANCE_HOST:INSTANCE_HOSTDB_ROOT_CERT:certs/server-ca.pem DB_CERT:certs/client-cert.pem DB_KEY:certs/client-key.pem PRIVATE_IP:TRUE vpc_access_connector: name:projects/PROJECT_ID/locations/us-central1/connectors/quickstart-connector

9. Make the following variable replacements:
• YOUR_DB_PASSWORD with the password of the quickstart-user that you created in Create a user.
• INSTANCE_HOST with your instance's Private IP address that appears on the Cloud SQL instances page in the Google Cloud console.
• PROJECT_ID with your project ID.
10. At the Cloud Shell command prompt, in the cloudshell_open/golang-samples/cloudsql/mysql/database-sql directory, run the following gcloud app deploy command to deploy the sample app to App Engine flexible environment.

gcloudappdeployapp.flexible.yaml

11. When prompted with Do you want to continue?, enter Y.
12. After the actions performed by running the gcloud app deploy command complete, run the gcloud app browse command:

gcloudappbrowse

13. Click the generated link to see the sample app running on App Engine flexible environment. This environment is connected to Cloud SQL.

Java

Create and download SSL server and client certificates

For Java users, the connector already provides a secure connection so that creating and downloading SSL server and client certificates is unnecessary.

Build sample app

1. In Cloud Shell Editor, open the sample app's source code.
   Open Cloud Shell Editor
2. In the Open in Cloud Shell dialog, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
3. At the Cloud Shell command prompt, run the following command to activate your project:

   gcloudconfigsetprojectYOUR-PROJECT-ID

4. If an Authorize Cloud Shell dialog appears, then click Authorize.
5. From the Explorer navigation menu of Cloud Shell Editor, click the expandable node that's the username of your Google Cloud account.
6. Navigate to and open the cloudshell_open/java-docs-samples/cloud-sql/mysql/servlet/src/main/webapp/WEB-INF/appengine-web.xml file.
7. Copy and paste the following code into the appengine-web.xml file, replacing the existing file content:

<runtime>java17</runtime> <env-variables> <env-varname="INSTANCE_CONNECTION_NAME"value="project-name:region-name:instance-name"/> <env-varname="DB_PORT"value="3306"/> <env-varname="DB_USER"value="quickstart-user"/> <env-varname="DB_PASS"value="my-db-password"/> <env-varname="DB_NAME"value="quickstart-db"/> </env-variables> <vpc-access-connector> <name>projects/PROJECT_ID/locations/us-central1/connectors/quickstart-connector</name> <egress-setting>all-traffic</egress-setting> </vpc-access-connector>

8. Make the following variable replacements:
• project-name:region-name:instance-name with your instance's Connection name that appears on the Cloud SQL instances page in the Google Cloud console.
• my-db-password with the password of the quickstart-user that you created in Create a user.
• PROJECT_ID with your project ID.
9. At the Cloud Shell command prompt, in the cloudshell_open/java-docs-samples/cloud-sql/mysql/servlet directory, run the following Apache Mavenmvn clean package command to deploy the sample app to App Engine flexible environment.

mvncleanpackageappengine:deploy-DskipTests

10. When prompted with Do you want to continue?, enter Y.
11. After the actions performed by running the gcloud app deploy command complete, run the gcloud app browse command:

gcloudappbrowse

12. Click the generated link to see the sample app running on App Engine flexible environment. This environment is connected to Cloud SQL.

Node.js

Create and download SSL server and client certificates

1. In the Google Cloud console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

2. Click the quickstart-instance to see its Overview page
3. Click the Connections tab.
4. Under the Security section, click Create client certificate.
5. In the Create a client certificate dialog, enter quickstart-key as the name and click Create.

6. In the New SSL certificate created dialog, click each download link to download the certificates. Then, click Close.

Build sample app with SSL certificates

1. In Cloud Shell Editor, open the sample app's source code.
   Open Cloud Shell Editor
2. In the Open in Cloud Shell dialog, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
3. At the Cloud Shell command prompt, run the following command to activate your project:

   gcloudconfigsetprojectYOUR-PROJECT-ID

4. If an Authorize Cloud Shell dialog appears, then click Authorize.
5. Upload SSL certs files to certs folder.
   1. From the Explorer navigation menu of Cloud Shell Editor, navigate to the nodejs-docs-samples/cloud-sql/mysql/mysql/certs folder.
   2. Right-click certs folder in Cloud Shell Editor and select Upload Files
   3. Select following files on your local machine:
   • client-key.pem
   • client-cert.pem
   • server-ca.pem
   4. With the three SSL certificate files selected, click Open to complete the process of uploading the files to Cloud Shell Editor.
6. From the Explorer navigation menu of Cloud Shell Editor, click the expandable node that's the username of your Google Cloud account.
7. Navigate to and open the cloudshell_open/nodejs-docs-samples/cloud-sql/mysql/mysql/app.flexible.yaml file.
8. Copy and paste the following code into the file, replacing the existing file content:

runtime:nodejs env:flex env_variables: DB_USER:quickstart-user DB_PASS:MY_DB_PASSWORDDB_NAME:quickstart-db DB_PORT:3306INSTANCE_HOST:INSTANCE_HOSTDB_ROOT_CERT:certs/server-ca.pem DB_CERT:certs/client-cert.pem DB_KEY:certs/client-key.pem PRIVATE_IP:TRUE vpc_access_connector: name:projects/PROJECT_ID/locations/us-central1/connectors/quickstart-connector

9. Make the following variable replacements:
• MY_DB_PASSWORD with the password of the quickstart-user that you created in Create a user.
• INSTANCE_HOST with your instance's Private IP address that appears on the Cloud SQL instances page in the Google Cloud console.
• PROJECT_ID with your project ID.
10. At the Cloud Shell command prompt, in the cloudshell_open/nodejs-docs-samples/cloud-sql/mysql/mysql directory, run the following gcloud app deploy command to deploy the sample app to App Engine flexible environment.

gcloudappdeployapp.flexible.yaml

11. When prompted with Do you want to continue?, enter Y.
12. After the actions performed by running the gcloud app deploy command complete, run the gcloud app browse command:

gcloudappbrowse

13. Click the generated link to see the sample app running on App Engine flexible environment. This environment is connected to Cloud SQL.

Python

Create and download SSL server and client certificates

1. In the Google Cloud console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

2. Click the quickstart-instance to see its Overview page
3. Click the Connections tab.
4. Under the Security section, click Create client certificate.
5. In the Create a client certificate dialog, enter quickstart-key as the name and click Create.

6. In the New SSL certificate created dialog, click each download link to download the certificates. Then, click Close.

Build sample app with SSL certificates

1. In Cloud Shell Editor, open the sample app's source code.
   Open Cloud Shell Editor
2. In the Open in Cloud Shell dialog, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
3. At the Cloud Shell command prompt, run the following command to activate your project:

   gcloudconfigsetprojectYOUR-PROJECT-ID

4. If an Authorize Cloud Shell dialog appears, then click Authorize.
5. Upload SSL certs files to certs folder.
   1. From the Explorer navigation menu of Cloud Shell Editor, navigate to the python-docs-samples/cloud-sql/mysql/sqlalchemy/certs folder.
   2. Right-click certs folder in Cloud Shell Editor and select Upload Files
   3. Select following files on your local machine:
   • client-key.pem
   • client-cert.pem
   • server-ca.pem
   4. With the three SSL certificate files selected, click Open to complete the process of uploading the files to Cloud Shell Editor.
6. From the Explorer navigation menu of Cloud Shell Editor, click the expandable node that's the username of your Google Cloud account.
7. Navigate to and open the cloudshell_open/python-docs-samples/cloud-sql/mysql/sqlalchemy/app.flexible.yaml file.
8. Copy and paste the following code into the file, replacing the existing file content:

runtime:custom env:flex entrypoint:gunicorn-b:$PORTapp:app env_variables: DB_USER:quickstart-user DB_PASS:YOUR_DB_PASSWORDDB_NAME:quickstart-db DB_PORT:3306INSTANCE_HOST:INSTANCE_HOSTDB_ROOT_CERT:certs/server-ca.pem DB_CERT:certs/client-cert.pem DB_KEY:certs/client-key.pem PRIVATE_IP:TRUE vpc_access_connector: name:projects/PROJECT_ID/locations/us-central1/connectors/quickstart-connector

9. Make the following variable replacements:
• YOUR_DB_PASSWORD with the password of the quickstart-user that you created in Create a user.
• INSTANCE_HOST with your instance's Private IP address that appears on the Cloud SQL instances page in the Google Cloud console.
• PROJECT_ID with your project ID.
10. At the Cloud Shell command prompt, in the cloudshell_open/python-docs-samples/cloud-sql/mysql/sqlalchemy directory, run the following gcloud app deploy command to deploy the sample app to App Engine flexible environment.

gcloudappdeployapp.flexible.yaml

11. When prompted with Do you want to continue?, enter Y.
12. After the actions performed by running the gcloud app deploy command complete, run the gcloud app browse command:

gcloudappbrowse

13. Click the generated link to see the sample app running on App Engine flexible environment. This environment is connected to Cloud SQL.