Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/googlecloudplatform/cloud-sql-jdbc-socket-factory

A collection of Java libraries for connecting securely to Cloud SQL
https://github.com/googlecloudplatform/cloud-sql-jdbc-socket-factory

cloud-sql java libraries mysql postgresql sql-server

Last synced: about 4 hours ago
JSON representation

A collection of Java libraries for connecting securely to Cloud SQL

Awesome Lists containing this project

README 

        
## Cloud SQL Connector for Java



[![CI][ci-badge]][ci-build]



[ci-badge]: https://github.com/GoogleCloudPlatform/cloud-sql-jdbc-socket-factory/actions/workflows/tests.yml/badge.svg?event=push

[ci-build]: https://github.com/GoogleCloudPlatform/cloud-sql-jdbc-socket-factory/actions/workflows/tests.yml?query=event%3Apush+branch%3Amain



The Cloud SQL Connector for Java is a library that provides IAM-based authorization and encryption when connecting to a Cloud SQL instance. It can *not* provide a network path to a Cloud SQL instance if one is not already present.  See the [Connecting Overview](https://cloud.google.com/sql/docs/mysql/connect-overview) page for more information on connecting to a Cloud SQL instance.



## Usage

For usage information specific to your database engine and driver, see the pages below:



* [Connecting to Cloud SQL using JDBC](docs/jdbc.md)

* [Connecting to Cloud SQL using R2DBC](docs/r2dbc.md)



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

[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/cloud-sql).



### Authentication



This library uses the [Application Default Credentials (ADC)][adc] strategy for

resolving credentials. Please see [these instructions for how to set your ADC][set-adc]

(Google Cloud Application vs Local Development, IAM user vs service account credentials).



[adc]: https://cloud.google.com/docs/authentication#adc

[set-adc]: https://cloud.google.com/docs/authentication/provide-credentials-adc

---



### 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.8.0-jar-with-dependencies.jar

postgres-socket-factory-1.8.0-jar-with-dependencies.jar

```



### Debug Logging



The Java Connector supports optional debug logging to help diagnose problems with

the background certificate refresh. To enable it, add the following to the file

`/src/main/resources/application.yml`:



```

logging.level.root=DEBUG

```



---



### 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](https://www.jetbrains.com/help/datagrip/connect-to-google-cloud-sql-instances.html) 

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 are no longer provided (since v1.14.0).

 

## Troubleshooting



Here are some troubleshooting tips to resolve common issues that come up when using the Java Connector:



1. Make sure you are using the latest version of the Cloud SQL Connector and your database driver to avoid incompatibilities. Some older versions of drivers are not supported.

1. The Java connector provides authorization for connections, but it does not provide new paths to connectivity. For example, in order to connect to a Cloud SQL instance using a Private IP address, your application must already have VPC access. 



## Support policy



### Major version lifecycle

This project uses [semantic versioning](https://semver.org/), and uses the

following lifecycle regarding support for a major version:



**Active** - Active versions get all new features and security fixes (that

wouldn’t otherwise introduce a breaking change). New major versions are

guaranteed to be "active" for a minimum of 1 year.

**Deprecated** - Deprecated versions continue to receive security and critical

bug fixes, but do not receive new features. Deprecated versions will be publicly

supported for 1 year.

**Unsupported** - Any major version that has been deprecated for >=1 year is

considered publicly unsupported.



### Supported JDK versions



We test and support at minimum, any publically supported LTS JDK version.

Changes in supported versions will be considered a minor change, and will be

listed in the realease notes.



### Release cadence

This project aims for a minimum monthly release cadence. If no new

features or fixes have been added, a new PATCH version with the latest

dependencies is released.