Cloud SQL Connector for Java

The Cloud SQL Connector for Java is a library for the MySQL/PostgreSQL JDBC and R2DBC drivers that allows a user with the appropriate permissions to connect to a Cloud SQL database without having to deal with IP whitelisting or SSL certificates manually.

Examples

For examples of this library being used in the context of an application, check out the sample applications located here.

Authentication

This library uses the Application Default Credentials to authenticate the connection to the Cloud SQL server. For more details, see the previously mentioned link.

To activate credentials locally, use the following gcloud command: ```bash gcloud auth application-default login

```

Instructions for JDBC

Add library as a dependency

MySQL

Note: Use your JDBC driver version to figure out which SocketFactory you should use. If you are unsure, it is recommended to use the latest version of

mysql-connector-java:8.x

| JDBC Driver Version | Cloud SQL Socket Factory Version | | -------------------------- | ---------------------------------------- | | mysql-connector-java:8.x | mysql-socket-factory-connector-j-8:1.1.0 | | mysql-connector-java:5.1.x | mysql-socket-factory:1.1.0 |

Maven

Include the following in the project's

pom.xml

maven-pom

    com.google.cloud.sql
    mysql-socket-factory-connector-j-8
    1.2.0

Gradle

Include the following the project's

build.gradle

gradle
compile 'com.google.cloud.sql:mysql-socket-factory-connector-j-8:1.2.0'

PostgreSQL

Maven

Include the following in the project's

pom.xml

maven-pom

    com.google.cloud.sql
    postgres-socket-factory
    1.2.0

Gradle

Include the following the project's

gradle.build

gradle
compile 'com.google.cloud.sql:postgres-socket-factory:1.2.0'

org.postgresql:postgresql:

SQL Server

Maven

Include the following in the project's

pom.xml

maven-pom

    com.google.cloud.sql
    cloud-sql-connector-jdbc-sqlserver
    1.2.0

Gradle

Include the following the project's

gradle.build

gradle
compile 'com.google.cloud.sql:cloud-sql-connector-jdbc-sqlserver:1.2.0'

Creating the JDBC URL

MySQL

Base JDBC URL:

jdbc:mysql:///

When specifying the JDBC connection URL, add the additional parameters:

| Property | Value | | ---------------- | ------------- | | socketFactory | com.google.cloud.sql.mysql.SocketFactory | | cloudSqlInstance | The instance connection name (found on the instance details page) | | user | MySQL username | | password | MySQL user's password |

The full JDBC URL should look like this:

jdbc:mysql:///?cloudSqlInstance=&socketFactory=com.google.cloud.sql.mysql.SocketFactory&user=&password=

Note: The host portion of the JDBC URL is currently unused, and has no effect on the connection process. The SocketFactory will get your instances IP address base on the provided

cloudSqlInstance

PostgreSQL

Base JDBC URL:

jdbc:postgresql:///

When specifying the JDBC connection URL, add the additional parameters:

| Property | Value | | ---------------- | ------------- | | socketFactory | com.google.cloud.sql.postgres.SocketFactory | | cloudSqlInstance | The instance connection name (found on the instance details page) | | user | PostgreSQL username | | password | PostgreSQL user's password |

The full JDBC URL should look like this:

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

Note: The host portion of the JDBC URL is currently unused, and has no effect on the connection process. The SocketFactory will get your instances IP address base on the provided

cloudSqlInstance

Instructions for R2DBC

Add library as a dependency

MySQL

Maven

Include the following in the project's

pom.xml

maven-pom
    
      com.google.cloud.sql
      cloud-sql-connector-r2dbc-mysql
      1.2.0
    

Gradle

Include the following the project's

build.gradle

gradle
compile 'com.google.cloud.sql:cloud-sql-connector-r2dbc-mysql:1.2.0'

*Note: Also include the R2DBC Driver for MySQL,

dev.miku:r2dbc-mysql:

PostgreSQL

Maven

Include the following in the project's

pom.xml

maven-pom
    
      com.google.cloud.sql
      cloud-sql-connector-r2dbc-postgres
      1.2.0
    

Gradle

Include the following the project's

build.gradle

gradle
compile 'com.google.cloud.sql:cloud-sql-connector-r2dbc-postgres:1.2.0'

io.r2dbc:r2dbc-postgresql:

SQL Server

Maven

Include the following in the project's

pom.xml

maven-pom
    
      com.google.cloud.sql
      cloud-sql-connector-r2dbc-sqlserver
      1.2.0
    

Gradle

Include the following the project's

build.gradle

gradle
compile 'com.google.cloud.sql:cloud-sql-connector-r2dbc-sqlserver:1.2.0'

io.r2dbc:r2dbc-mssql:

Creating the R2DBC URL

MySQL

R2DBC URL template:

r2dbc:gcp:mysql://:@/

Add the following parameters:

| Property | Value | | ---------------- | ------------- | | DATABASENAME | The name of the database to connect to | | CLOUDSQLCONNECTIONNAME | The instance connection name (found on the instance details page) | | DBUSER | MySQL username | | DBPASS | MySQL user's password |

PostgreSQL

R2DBC URL template:

r2dbc:gcp:postgres://:@/

Add the following parameters:

| Property | Value | | ---------------- | ------------- | | DATABASENAME | The name of the database to connect to | | CLOUDSQLCONNECTIONNAME | The instance connection name (found on the instance details page) | | DBUSER | PostgreSQL username | | DBPASS | PostgreSQL user's password |

SQL Server

R2DBC URL template:

r2dbc:gcp:mssql://:@/

Add the following parameters:

| Property | Value | | ---------------- | ------------- | | DATABASENAME | The name of the database to connect to | | CLOUDSQLCONNECTIONNAME | The instance connection name (found on the instance details page) | | DBUSER | SQL Server username | | DBPASS | SQL Server user's password |

Building the Drivers

To build a fat JAR containing the JDBC driver with the bundles Socket Factory dependencies you can issue the following Maven command from the location containing the project pom.xml:

mvn -P jar-with-dependencies clean package -DskipTests

This will create a target sub-folder within each of the module directories. Within these target directories you'll find the JDBC driver files.

Example:

mysql-socket-factory-connector-j-8–1.0.16-jar-with-dependencies.jar
postgres-socket-factory-1.0.16-jar-with-dependencies.jar

Additional Information

Specifying IP Types

The

ipTypes

ipTypes=PRIVATE

PUBLIC,PRIVATE

Firewall configuration

The Cloud SQL proxy establishes connections to Cloud SQL instances using port 3307. Applications that are protected by a firewall may need to be configured to allow outgoing connections on TCP port 3307. A connection blocked by a firewall typically results in an error stating connection failure (e.g.

com.mysql.jdbc.exceptions.jdbc4.CommunicationsException: Communications link failure

Connect with IntelliJ

In order to connect IntelliJ to your Cloud SQL instance, you will need to add this library as a jar with dependencies in "Additional Files" section on the driver settings page. Prebuilt fat jars can be found on the Releases page for this purpose.

Connection via Unix Sockets

To connect using a Unix domain socket (such as the one created by the Cloud SQL proxy), you can use the

unixSocketPath

Example using MySQL:

jdbc:mysql:///?unixSocketPath=&cloudSqlInstance=&socketFactory=com.google.cloud.sql.mysql.SocketFactory&user=&password=

Example using PostgreSQL:

jdbc:postgresql:///?unixSocketPath=&cloudSqlInstance=&socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=&password=