Cloud SQL

Cloud SQL is managed MySQL, PostgreSQL, and SQL Server. Cloud SQL automates backups, replication, and failover to ensure your database is reliable, highly available.

Cloud SQL has automatic data encryption at rest and in transit. Private connectivity with Virtual Private Cloud (VPC) and user-controlled network access that includes firewall protection. Compliant with SSAE 16, ISO 27001, PCI DSS v3.0, and HIPAA

Cloud SQL Instance

Enable API

gcloud services enable sqladmin.googleapis.com

Create an Instance

MySQL

Create a new Cloud SQL - MySQL Instance.

gcloud sql instances create mysql-instance \
  --database-version=MYSQL_5_7 \
  --region=us-central1 \
  --cpu=2 \
  --memory=4G \
  --root-password=[CHOOSE A PASSWORD]

PostgreSQL

Create a new Cloud SQL - PostgreSQL instance.

gcloud sql instances create postgresql-instance \
  --database-version=POSTGRES_11 \
  --region=us-central1 \
  --cpu=2 \
  --memory=4G \
  --root-password=[CHOOSE A PASSWORD]

SQL Server

Create a new Cloud SQL - SQL Server instance.

gcloud beta sql instances create sqlserver-instance \
  --database-version=SQLSERVER_2017_STANDARD \
  --region=us-central1 \
  --cpu=2 \
  --memory=4G \
  --root-password=[CHOOSE A PASSWORD]

Create a Database

MySQL

Create a new database inside of the MySQL database instance.

gcloud sql databases create orders --instance=mysql-instance

PostgreSQL

Create a new database inside of the PostgreSQL database instance.

gcloud sql databases create orders --instance=postgresql-instance

SQL Server

Create a new database inside of the SQL Server database instance.

gcloud sql databases create orders --instance=sqlserver-instance

Connect to Database instance

By default, every database instance has a public IP address. However, the instance is not publicly accessible because it's protected by the firewall.

To easily connect to the database instance from command line:

MySQL

You need the MySQL client installed locally first, so that you can use mysql to connect to any MySQL server.

Connect to the MySQL instance using gcloud CLI.

gcloud sql connect mysql-instance

PostgreSQL

You need the PostgreSQL client installed locally first, so that you can use psql to connect to any PostgreSQL server.

Connect to the PostgreSQL instance using gcloud CLI.

gcloud sql connect postgresql-instance

SQL Server

You need the MS SQL Server client installed locally first, so that you can use mssql-cli to connect to any SQL Server.

Connect to the SQL Server instance using gcloud CLI.

gcloud sql connect sqlserver-instance

You can configure Cloud SQL instances to only have private IP addresses, so that it's only accessible from a Virtual Private Cloud network.

Create a Table

From the command line connection, you can use the client to create a table for the corresponding database. For example:

MySQL

# Change to orders database
USE orders;

CREATE TABLE order_items (
  id BIGINT NOT NULL AUTO_INCREMENT PRIMARY KEY,
  order_id BIGINT,
  description VARCHAR(255),
  quantity INT DEFAULT 1
);

CREATE TABLE orders (
  id BIGINT NOT NULL AUTO_INCREMENT PRIMARY KEY,
  description VARCHAR(255),
  creation_timestamp TIMESTAMP
);

ALTER TABLE order_items ADD FOREIGN KEY (order_id) REFERENCES orders (id);

PostgreSQL

# Change to orders database
\c orders

CREATE TABLE order_items (
  id BIGSERIAL NOT NULL PRIMARY KEY,
  order_id BIGINT,
  description VARCHAR(255),
  quantity INT DEFAULT 1
);

CREATE TABLE orders (
  id BIGSERIAL NOT NULL PRIMARY KEY,
  description VARCHAR(255),
  creation_timestamp TIMESTAMP
);

ALTER TABLE order_items ADD FOREIGN KEY (order_id) REFERENCES orders (id);

SQL Server

USE orders;

CREATE TABLE order_items (
  id BIGINT NOT NULL IDENTITY(1,1) PRIMARY KEY,
  order_id BIGINT,
  description VARCHAR(255),
  quantity INT DEFAULT 1
);

CREATE TABLE orders (
  id BIGINT NOT NULL IDENTITY(1,1) PRIMARY KEY,
  description VARCHAR(255),
  creation_timestamp TIMESTAMP
);

ALTER TABLE order_items ADD FOREIGN KEY (order_id) REFERENCES orders (id);

Add a User

You can add a user using gcloud command line:

MySQL

Use gcloud command line to create a new user:

gcloud sql users create order-user
  --instance=mysql-instance \
  --password=...

The new user has no privileges. Connect to the database server and grant privileges. Refer to MySQL documentation to use GRANT.

PostgreSQL

Use gcloud command line to create a new user:

gcloud sql users create order-user \
  --instance=postgresql-instance \
  --password=...

The new user has no privileges. Connect to the database server and grant privileges. Refer to PostgreSQL documentation to use GRANT.

SQL Server

Use gcloud command line to create a new user:

gcloud sql users create order-user \
  --instance=sqlserver-instance \
  --password=...

The new user has no privileges. Connect to the database server and grant privileges. Refer to SQL Server documentation to use GRANT.

Instance Connection Name

Every Cloud SQL Instance has a unique instance connection name for the form of PROJECT_ID:REGION:INSTANCE_NAME.

Find the Instance Connection Name using gcloud command line:

gcloud sql instances describe INSTANCE_NAME --format='value(connectionName)'

MySQL

MySQL instance's Instance Connection Name

gcloud sql instances describe mysql-instance \
  --format='value(connectionName)'

PostgreSQL

PostgreSQL instance's Instance Connection Name

gcloud sql instances describe postgresql-instance \
  --format='value(connectionName)'

SQL Server

SQL Server instance's Instance Connection Name

gcloud sql instances describe sqlserver-instance \
  --format='value(connectionName)'

JDBC

There are different ways to connect to a Cloud SQL instance. All methods will configure a JDBC URL to allow you to use the corresponding JDBC Driver, and subsequently, JPA / Hibernate and Spring Data.

Method	MySQL	PostgreSQL	SQL Server	Considerations
Cloud SQL Starter	✅	✅	🚫	Easy to configure for Spring Boot projects.
Cloud SQL Socket Factory	✅	✅	🚫	Works with non Spring Boot projects.
Cloud SQL Proxy	✅	✅	✅	Offloads authentication to proxy.
VPC Private IP	✅	✅	✅	Access via VPC. Can be used with all of the other methods above.

Cloud SQL Starter

When using Spring Boot, you can use Spring Cloud GCP's Cloud SQL starter.

Cloud SQL starter will automatically:

• Add dependency to the corresponding JDBC driver, and the Cloud SQL socket factory. You do not need to add those dependency separately.
• Configure the JDBC URL for the corresponding database instance.

Dependency

Add the Cloud SQL Starter dependency:

MySQL

Maven:

pom.xml

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-gcp-starter-sql-mysql</artifactId>
</dependency>

Gradle:

build.gradle

dependencies {
    compile group: 'org.springframework.cloud', name: 'spring-cloud-gcp-starter-sql-mysql'
}

PostgreSQL

Maven:

pom.xml

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-gcp-starter-sql-postgresql</artifactId>
</dependency>

Gradle:

build.gradle

compile group: 'org.springframework.cloud', name: 'spring-cloud-gcp-starter-sql-postgresql'

SQL Server

Cloud SQL Starter is not supported for SQL Server. Use Cloud SQL Proxy instead.

Configuration

Configure Spring Boot application'sapplication.properties with Instance Connection Name and the database name:

application.properties

# Retrieve instance connection name from the previous step
spring.cloud.gcp.sql.instance-connection-name=INSTANCE_CONNECTION_NAME
spring.cloud.gcp.sql.database-name=orders

# Cloud SQL starter automatically configures the JDBC URL

# Configure username/password
spring.datasource.username=...
spring.datasource.password=...

# Configure connection pooling if needed
spring.datasource.hikari.maximum-pool-size=10

Sample

• Spring Boot with Cloud SQL PostgreSQL
• Spring Boot with Cloud SQL MySQL

Cloud SQL Socket Factory

If you don't use Spring Cloud GCP's Cloud SQL starter, and need to configure JDBC URL directly, you can use Cloud SQL Socket Factory with existing JDBC driver.

Dependency

In addition to the JDBC Driver dependency, add the Cloud SQL Socket Factory dependency:

MySQL

Maven:

<dependency>
    <groupId>com.google.cloud.sql</groupId>
    <artifactId>mysql-socket-factory-connector-j-8</artifactId>
    <version>1.1.0</version>
</dependency>

Gradle:

build.gradle

dependencies {
    compile 'com.google.cloud.sql:mysql-socket-factory-connector-j-8:1.1.0'
}

Different MySQL Socket Factory artifact is needed for different MySQL Connector/J versions. See MySQL Socket Factory README for more information.

PostgreSQL

Maven:

<dependency>
    <groupId>com.google.cloud.sql</groupId>
    <artifactId>postgres-socket-factory</artifactId>
    <version>1.1.0</version>
</dependency>

Gradle:

build.gradle

dependencies {
    compile 'com.google.cloud.sql:postgres-socket-factory:1.1.0'
}

Configuration

MySQL

MySQL instance's JDBC URL with Cloud SQL Socket Factory follows the format of:

jdbc:mysql:///DATABASE_NAME?cloudSqlInstance=INSTANCE_CONNECTION_NAME&socketFactory=com.google.cloud.sql.mysql.SocketFactory

The JDBC URL for the Cloud SQL instance in this example is:

jdbc:mysql:///orders?cloudSqlInstance=PROJECT_ID:us-central1:mysql-instance&socketFactory=com.google.cloud.sql.mysql.SocketFactory

PostgreSQL

PostgreSQL instance's JDBC URL with Cloud SQL Socket Factory follows the format of:

jdbc:postgresql:///DATABASE_NAME?cloudSqlInstance=INSTANCE_CONNECTION_NAME&socketFactory=com.google.cloud.sql.postgres.SocketFactory

The JDBC URL for the Cloud SQL instance in this example is:

jdbc:postgresql:///orders?cloudSqlInstance=PROJECT_ID:us-central1:postgresql-instance&socketFactory=com.google.cloud.sql.postgres.SocketFactory

SQL Server

Cloud SQL Socket Factory is not supported for SQL Server. Use Cloud SQL Proxy instead.

Cloud SQL Proxy

Cloud SQL Proxy is the generic way of establishing secured connection to a Cloud SQL instance. Rather than using the Cloud SQL Socket Factory to exchange certificates, Cloud SQL Proxy will authenticate and exchange the certificates.

Cloud SQL Proxy diagram

Install Cloud SQL Proxy:

gcloud components install cloud_sql_proxy

Start the proxy:

MySQL

# Refer to Instance Connection Name from previous section
cloud_sql_proxy -instances=INSTANCE_CONNECTION_NAME=tcp:3306

PostgreSQL

# Refer to Instance Connection Name from previous section
cloud_sql_proxy -instances=INSTANCE_CONNECTION_NAME=tcp:5432

SQL Server

# Refer to Instance Connection Name from previous section
cloud_sql_proxy -instances=INSTANCE_CONNECTION_NAME=tcp:1433

You can then establish connections on localhost with the corresponding ports.

MySQL

Connect with mysql CLI:

mysql -u root -p

Or, connect with JDBC using JDBC URL:

jdbc:mysql://localhost/orders

PostgreSQL

Connect with psql CLI:

psql -h localhost -U postgres

Or, connect with JDBC using JDBC URL:

jdbc:postgresql://localhost/orders

SQL Server

Connect with mssql-cli CLI:

mssql-cli -U sqlserver

Or, connect with JDBC using JDBC URL:

jdbc:sqlserver://localhost/databaseName=orders

Unix Socket Domain

You can optionally configure Cloud SQL Proxy to expose not a TCP IP port, but using Unix Socket Domain instead, and configure the Cloud SQL Socket Factory to connect using the Unix Socket Domain. See Connect External App documentation for more details.

VPC Private IP

If your Cloud SQL instance is on VPC and has a private IP, and your application is running in the Cloud able to access the same VPC, then configure JDBC drivers normally connecting to the private IP address.

R2DBC

You can use R2DBC driver for reactive database access when you connect to Cloud SQL instances using:

• Cloud SQL Proxy

• VPC Private IP

• Using R2DBC Cloud SQL Connector

Cloud SQL Proxy or VPC Private IP

You can use standard R2DBC driver to connect using the IP address. See R2DBC documentation for corresponding driver usages:

• r2dbc-mysql
• r2dbc-postgresql
• r2dbc-mssql

Cloud SQL Connector

You can use R2DBC Cloud SQL Connector that automatically exchanges the certificates like the Cloud SQL Socket Factory.

See Cloud SQL Socket Factory README for more information on configuring the R2DBC driver for Cloud SQL.