Snowflake provides a JDBC type 4 driver that supports core functionality, allowing Java program to connect to Snowflake.
The Snowflake JDBC driver requires Java 1.8 or higher. If the minimum required version of Java is not installed on the client machines where the JDBC driver is installed, you must install either Oracle Java or OpenJDK.
Add following dependency for fat-jar
<dependency>
<groupId>net.snowflake</groupId>
<artifactId>snowflake-jdbc</artifactId>
<version>{version}</version>
</dependency>
or for FIPS compliant fat-jar
<dependency>
<groupId>net.snowflake</groupId>
<artifactId>snowflake-jdbc-fips</artifactId>
<version>{version}</version>
</dependency>
or for experimental thin-jar
<dependency>
<groupId>net.snowflake</groupId>
<artifactId>snowflake-jdbc-thin</artifactId>
<version>{version}</version>
</dependency>
- Checkout source code from Github by running:
git clone https://github.com/snowflakedb/snowflake-jdbc.git
- Build the fat-jar and install it in local maven repository by running:
./mvnw clean verify
./mvnw org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile=target/snowflake-jdbc.jar -DpomFile=./public_pom.xml
- Build the FIPS compliant fat-jar and install it in local maven repository by running:
cd FIPS
../mvnw clean verify
../mvnw org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile=target/snowflake-jdbc-fips.jar -DpomFile=./public_pom.xml
cd -
- Build the experimental thin-jar and install it in local maven repository by running:
./mvnw clean verify -Dnot-self-contained-jar -Dthin-jar
./mvnw org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile=target/snowflake-jdbc-thin.jar -DpomFile=./thin_public_pom.xml -Dnot-self-contained-jar -Dthin-jar
thin-jar
enables thin jar profilenot-self-contained-jar
turns off fat jar profile (enabled by default)
- Note that the built dependencies are installed with version 1.0-SNAPSHOT
Class.forName("net.snowflake.client.jdbc.SnowflakeDriver")
javax.sql.DataSource interface is implemented by class
net.snowflake.client.jdbc.SnowflakeBasicDataSource
US(West) Region:
jdbc:snowflake://<account>.snowflakecomputing.com/?<connection_params>
EU(Frankfurt) Region:
jdbc:snowflake://<account>.eu-central-1.snowflakecomputing.com/?<connection_params>
For detailed documentation, please refer to https://docs.snowflake.net/manuals/user-guide/jdbc.html
Run the maven command to check the coding style.
mvn -P check-style validate
Follow the instruction if any error occurs or run this command to fix the formats.
mvn com.spotify.fmt:fmt-maven-plugin:format
You may import the coding style from IntelliJ so that the coding style can be applied on IDE:
In the File -> Settings/Plugins, and install google-java-format plugin.
Enable google-java-format for the JDBC project.
In the source code window, select Code -> Reformat to apply the coding style.
Additionally configure IDE in File -> Editor -> Code Style -> Java to - not use wildcard imports (tab Imports):
- Use single class import
- Class count to use import with '*' to 1000
- Names count to use static import with '*' to 1000
- always use braces in
if/while/for/do..while
in (tab Wrapping and Braces)
Set the environment variables to specify the target database.
export SNOWFLAKE_TEST_HOST=<your_host>
export SNOWFLAKE_TEST_ACCOUNT=<your_account>
export SNOWFLAKE_TEST_USER=<your_user>
export SNOWFLAKE_TEST_PASSWORD=<your_password>
export SNOWFLAKE_TEST_DATABASE=<your_database>
export SNOWFLAKE_TEST_SCHEMA=<your_schema>
export SNOWFLAKE_TEST_WAREHOUSE=<your_warehouse>
export SNOWFLAKE_TEST_ROLE=<your_role>
Run the maven verify
goal.
mvn -DjenkinsIT -DtestCategory=net.snowflake.client.category.<category> verify
where category
is the class name under the package net.snowflake.client.category
.
- Run maven command with passing specific version:
mvn -f parent-pom.xml versions:set -DnewVersion=... -DgenerateBackupPoms=false
- Set manually the same version in field
implementVersion
insrc/main/java/net/snowflake/client/jdbc/SnowflakeDriver.java
when it's version for release or without-SNAPSHOT
suffix between releases - Add entry in
CHANGELOG.rst
for release versions
The test cases are fallen into a couple of criteria:
- The unit test class names end with
Test
. They run part of the JDBC build jobs. - The integration test class names end with
IT
. They run part of theverify
maven goal along with the test category specified by the parametertestCategory
havingnet.snowflake.client.category
classes. - The manual test class names end with
Manual
. They don't run in the CI but you can run them manually.
Aside from the general test criteria, the test case class names ending with LatestIT
run only with the latest JDBC driver.
The main motivation behind is to skip those tests for the old JDBC driver. See ./TestOnly
directory for further information.
Feel free to file an issue or submit a PR here for general cases. For official support, contact Snowflake support at: https://community.snowflake.com/s/article/How-To-Submit-a-Support-Case-in-Snowflake-Lodge