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.2.1 |
| mysql-connector-java:5.1.x | mysql-socket-factory:1.2.1 |
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.2.1</version>
</dependency>Include the following the project's build.gradle
compile 'com.google.cloud.sql:mysql-socket-factory-connector-j-8:1.2.1'Base JDBC URL: jdbc:mysql:///<DATABASE_NAME>
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:///<DATABASE_NAME>?cloudSqlInstance=<INSTANCE_CONNECTION_NAME>&socketFactory=com.google.cloud.sql.mysql.SocketFactory&user=<MYSQL_USER_NAME>&password=<MYSQL_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 based on the provided cloudSqlInstance arg.
"The ipTypes argument is used to specify a preferred order of IP types used to connect via a comma delimited list. For example, ipTypes=PUBLIC,PRIVATE will use the instance's Public IP if it exists, otherwise private. The value ipTypes=PRIVATE will force the Cloud SQL instance to connect via it's private IP. If not specified, the default used is ipTypes=PUBLIC,PRIVATE.
For more info on connecting using a private IP address, see Requirements for Private IP.
To connect using a Unix domain socket (such as the one created by the Cloud SQL
proxy), you can use the unixSocketPath property to specify a path to a local
file instead of connecting directly over TCP.
jdbc:mysql:///<DATABASE_NAME>?unixSocketPath=</PATH/TO/UNIX/SOCKET>&cloudSqlInstance=<INSTANCE_CONNECTION_NAME>&socketFactory=com.google.cloud.sql.mysql.SocketFactory&user=<MYSQL_USER_NAME>&password=<MYSQL_USER_PASSWORD>
Examples for using the Cloud SQL JDBC Connector for MySQL can be found by looking at the integration tests in this repository.