Connect to Cloud SQL for PostgreSQL from Compute Engine
Learn how to deploy a sample app on your Linux or Windows based Compute Engine VM instance connected to a PostgreSQL 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 a Compute Engine VM instance.
Console
Click the Enable APIs button to enable the API required for this quickstart.
This enables the following API:
- Cloud SQL Admin 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 terminal or a Powershell window.Run the following
gcloud
command:gcloud services enable sqladmin.googleapis.com
This command enables the following API:
- Cloud SQL Admin API
Set up Cloud SQL
Create a Cloud SQL instance
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 New database dialog box, enter
quickstart_db
as the name of the database.
- 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.
- On the Add a user account to instance instance_name page,
add the following information:
- In the Username field, enter
quickstart-user
- In the Password field, specify a password for your database user. Make a note of this for use in a later step of this quickstart.
- In the Username field, enter
- Click Add.
gcloud
Before running the following command, make the following replacements:
- 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 PostgreSQL.
Configure a Compute Engine 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 Add another role and choose the Storage Object Viewer role to grant to the service account on the project.
- Click Continue.
- Click Done to finish creating the service account.
gcloud
Create a service account
- To create the service account, run the
gcloud iam service-accounts create
command:
gcloud iam service-accounts create quickstart-service-account --description="DESCRIPTION" --display-name="quickstart-service-account"
Replace the following value:
DESCRIPTION
: an optional description of the service account
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" --role="roles/storage.objectViewer"
Create Compute Engine VM instance
Create a Compute Engine VM Instance to host a sample web app that connects to Cloud SQL.
Access Compute Engine VM instance
Setup development environment for programming language
Set up the Compute Engine VM instance's development environment for your preferred programming language.
Install Git
Install Git, an open source version control system on to your Compute Engine VM instance.
Clone sample app
Clone a sample app to your Compute Engine VM instance using the git clone
command.
Go
On your Compute Engine VM instance, open a new terminal or Powershell window. Run the following commands to clone the Go sample app and change the 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/postgres/database-sql
Java
On your Compute Engine VM instance, open a new terminal or Powershell window. Run the following commands to clone the Java sample app and change the 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/postgres/servlet
Node.js
On your Compute Engine VM instance, open a new terminal or Powershell window. Run the following commands to clone the Node.js sample app and change the 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/postgres/knex
Python
On your Compute Engine VM instance, open a new terminal or Powershell window. Run the following commands to clone the Python sample app and change the 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/postgres/sqlalchemy
Configure and run a Cloud SQL sample app
With a Cloud SQL instance, database, and service account with client permissions, you can now configure a sample application running on your Compute Engine VM instance to connect to your Cloud SQL instance.
Clean up
To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.
Delete Cloud SQL instance
-
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.
Delete Compute Engine VM instance
-
In the Google Cloud console, go to the VM instances page.
- Select the
quickstart-vm-instance
instance to open the Instance details page. - In the icon bar at the top of the page, click Delete.
- Click Delete to delete the instance.
Optional cleanup steps
If you're not using the Cloud SQL client role that you assigned to the
Compute Engine default
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 Compute Engine default service account.
- Delete the Cloud SQL client role.
- Click Save.
If you're not using the API that was enabled as part of this quickstart, you can disable it.
- API that was enabled within this quickstart:
- Cloud SQL Admin 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 PostgreSQL users and databases for your Cloud SQL instance.
For more information about pricing, see Cloud SQL for PostgreSQL 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: