Using the JDBC driver

Firebolt provides a type 4 JDBC driver to connect to Firebolt from Java applications such as Tableau, DBeaver, and others. The driver is released as open source software using a permissive Apache 2 license and can be browsed, forked, downloaded, and contributed to through its GitHub repository.

• Download the JAR file
• Adding the Firebolt JDBC driver as a Maven dependency
• Adding the Firebolt JDBC driver as a gradle dependency
• Connecting to Firebolt with the JDBC driver
  • Available connection parameters
  • System settings as connection parameters
• Applying system settings using SET
• Full reference documentation

Download the JAR file

The Firebolt JDBC driver is provided as a JAR file and requires Java 1.8 or later.

Download the Firebolt JDBC driver JAR file from the GitHub Releases page.

Adding the Firebolt JDBC driver as a Maven dependency

If you are using Apache Maven, you can configure and build your projects to use the Firebolt JDBC driver to connect to your Firebolt resources. To do this, add the JDBC driver as a dependency in your project pom.xml file by including a link to the Firebolt Maven repository.

See below for an example pom.xml file:

Be sure to replace <version>0.00</version> with the latest (highest) version number. You can identify the latest version by viewing the version history in the Firebolt Maven repository.

<!-- pom.xml  -->

<project ...>
    ...
    <repositories>
    		...
    		<repository>
  	    		<id>repsy</id>
  	    		<name>Firebolt Private Maven Repository on Repsy</name>
  	    		<url>https://repo.repsy.io/mvn/firebolt/maven</url>
	    	</repository>
	    	...
  	</repositories>
  	...
<dependency>
            	<groupId>com.firebolt</groupId>
            	<artifactId>firebolt-jdbc</artifactId>
            	<version>0.00</version>
       </dependency>
</project>

Adding the Firebolt JDBC driver as a gradle dependency

Be sure to replace <version>0.00</version> with the latest (highest) version number. You can identify the latest version by viewing the version history in the Firebolt Maven repository.

/* build.gradle */

repositories {
    mavenCentral()
    maven {
      url 'https://repo.repsy.io/mvn/firebolt/maven'
    }
}

dependencies {
    implementation 'com.firebolt:firebolt-jdbc:0.00'
}

Connecting to Firebolt with the JDBC driver

Connection details are provided to the Firebolt JDBC driver in a connection string. The string has the following format:

jdbc:firebolt://api.app.firebolt.io/<database>?<connection_params>

<database>
The name of the Firebolt database to connect to.

<connection_params>
A list of connection parameters following the standard URL query string format.

Here is an example of a connection string:

jdbc:firebolt://api.app.firebolt.io/my_database?user=me%40mycompany.com&password=verysecurepassword123&engine=my_database_general_purpose&buffer_size=1000000&connection_timeout_millis=10000

Since the connection string is a URI, make sure to percent-encode any reserved characters or special characters used in parameter keys or parameter values.

Available connection parameters

The table below lists the available connection parameters that can be added to the Firebolt JDBC connection string. All parameter keys are case-sensitive.

System settings as connection parameters

In addition to the parameters specified above, any system setting can be passed as a connection string parameter. For example, if you wanted to set a custom CSV delimiter, your connection string would be as follows:

jdbc:firebolt://api.app.firebolt.io/my_database?format_csv_delimeter=%7C&<other_connection_params>

Applying system settings using SET

In addition to passing system settings as connection string parameters, any system setting can be passed to Firebolt as a SET command in SQL. Multiple SET statements can passed at once as long as they immediately follow one after another separated by semicolons, as shown in the following example.

SET input_format_csv_allow_single_quotes = 0;
SET format_csv_delimiter = |;

Full reference documentation

Complete reference documentation for the classes and methods implemented in the Firebolt JDBC driver can be found here.