hfwang/cloud-sql-jdbc-socket-factory

The Cloud SQL Socket Factory is a library for the MySQL/Postgres JDBC 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.

This library is available

Maven Central.

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:

gcloud auth application-default login

Note: Use the correct version to match your JDBC driver:

Include the following in the project's pom.xml:

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

Include the following the project's gradle.build

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

Include the following in the project's pom.xml:

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

Include the following the project's gradle.build

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

Base JDBC url: jdbc:mysql://google/<DATABASE_NAME>

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

The full JDBC url should look like this:

jdbc:mysql://google/<DATABASE_NAME>?cloudSqlInstance=<INSTANCE_CONNECTION_NAME>&socketFactory=com.google.cloud.sql.mysql.SocketFactory&useSSL=false&user=<MYSQL_USER_NAME>&password=<MYSQL_USER_PASSWORD>

Base JDBC url: jdbc:postgres://google/<DATABASE_NAME>

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

The full JDBC url should look like this:

jdbc:postgresql://google/<DATABASE_NAME>?cloudSqlInstance=<INSTANCE_CONNECTION_NAME>&socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=<POSTGRESQL_USER_NAME>&password=<POSTGRESQL_USER_PASSWORD>

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.

The library will automatically detect when it is running on GAE Standard, and will connect via the provided unix socket for reduced latency.

To force the library to connect to a unix socket (typically created by the Cloud SQL proxy) when running outside of the GAE-Standard environment, set the environment variable CLOUD_SQL_FORCE_UNIX_SOCKET to any value.