Legacy JDBC Driver

Dremio provides a JDBC driver that allows client applications to connect to Dremio Cloud. This driver is licensed under Apache-2.0.

You can download the JDBC driver from here. The driver does not require installation.

caution

It is recommended to use the JDBC driver for Arrow Flight SQL, rather than this legacy JDBC driver.

Supported Authentication Methods

• Use personal access tokens. To generate one, see Personal Access Tokens.
• Use JSON Web Tokens (JWT) from an external token provider. To use a JWT, you must have OAuth enabled in Dremio Cloud. For more information about using JWTs, see External Token Providers.

Construct a Connection String for JDBC Applications

note

If you are using the JDBC driver to connect to Dremio Cloud from a supported client application, refer to the documentation for creating connections from that application.

note

If you want to start with the base JDBC connection string for your Dremio Cloud project:

1. Click Project Settings in the side navigation bar.

2. Select General Information in the project settings sidebar.

3. Copy the connection string that is in the JDBC Connection field.

To construct a connection string:

1. Set the subprotocol to jdbc:dremio:.

2. Set the property direct equal to sql.dremio.cloud:443.

3. Add one of these types of authentication credentials for connecting from your JDBC client application to Dremio Cloud:

   • Use a personal access token (PAT) in either of the following ways:

     • Set user to $token and use the PAT as the password when the client application does not support OAuth:

       Use PAT as password when client app does not support OAuth

       jdbc:dremio:direct=sql.dremio.cloud:443;user=$token;password=<personal-access-token>;

     • Set token_type to personal_access_token, use the PAT as the password, and set username to null when the client application supports OAuth:

       Use PAT as password

       jdbc:dremio:direct=sql.dremio.cloud:443;token_type=personal_access_token;password=<personal-access-token>;username=;

   • Use a JSON Web Token (JWT). You can use a JWT when the tool used with the JDBC driver supports OAuth:

     Use a JWT

     jdbc:dremio:direct=sql.dremio.cloud:443;token_type=jwt;password=<jwt>;username=;

4. Set the property ssl equal to true: ssl=true;

5. Add the ID of the project that you are connecting to: project_id=<project-id>;

6. (Optional) Route queries to a particular engine in your project, set the property engine to the name of an engine: engine=<engine-name>;

Encryption Parameters

To encrypt communication between your JDBC client applications and Dremio Cloud, use the SSL JDBC connection parameters and a fully qualified host name to configure the JDBC connection string and connect to Dremio.

SSL JDBC Connection Parameter	Type	Description	Default Value	Required
disableCertificateVerification	boolean	Controls whether the driver verifies the host certificate against the trust store. The driver will verify the certificate against the trust store when it is set to false. The driver will not verify the certificate against the trust store when the value is set to true .	false	No
disableHostVerification	boolean	Forces the driver to verify that the host in the certificate is the host being connected to. The driver will verify the certificate against the host being connected to when it is set to false. The driver will not verify the certificate against the host whe it is set to true.	false	No
ssl	boolean	Forces the client to use an SSL encrypted connection to communicate with the Dremio server. SSL encryption is disabled with the client when it is set to false. The client communicates with the Dremio server only using SSL encryption when it is set to true. Note: To connect to Dremio Cloud, SSL must be enabled.	false	Yes
trustStoreType	string	The trustStore type. Accepted value is: JKS PKCS12 The following property only applies to Windows. If the useSystemTrustStore parameter is set to true, the accepted values are: Windows-MY and Windows-ROOT. Import the certificate into the Trusted Root Certificate Authorities and set trustStoreType=Windows-ROOT. Import the certificate into Trusted Root Certificate Authorities or Personal and set trustStoreType=Windows-MY.	None	No
trustStore	string	Path to the truststore. If this parameter is not specified, it defaults to Java truststore ($JAVA_HOME/lib/security/cacerts) and the trustStorePassword parameter is ignored.	$JAVA_HOME/lib/security/cacerts	No
useSystemTrustStore	boolean	Bypasses trustStoreType and automatically picks the correct truststore based on the operating system: Keychain on MacOS Local Machine and Current User Certificate Stores on Windows Default truststore on other systems	true	No
trustStorePassword	string	Password to the truststore.	None	No

SOCKS Proxy Connection Parameters

If you want to connect to Dremio Cloud through a SOCKS proxy, use these connection parameters:

Parameter	Type	Description	Default Value	Required?
socksProxyHost	string	The IP address or hostname of the SOCKS proxy.	N/A	Yes
socksProxyPort	integer	The port to use on the SOCKS proxy.	1080	No
socksProxyUsername	string	The username to use for connections.	N/A	No
socksProxyPassword	string	The password to use for connections.	N/A	Only if a username is specified.

Advanced Parameters

Name	Type	Description	Default Value
quoting	string	Specifies which type of character to use to delimit values in queries. The value can be BACK_TICK, BRACKET, or DOUBLE_QUOTE.	DOUBLE_QUOTE
routing_tag	string	When this parameter is set, the specified tag is associated with all queries executed within a session. Rules can check for the presence of a tag with the function "tag()". For more information, see Workload Management.	N/A
stringColumnLength	string	The maximum length of data in columns of the STRING datatype and of complex datatypes. The range is 1 to 2147483647.	1024.