JDBC

Dremio provides a JDBC driver that allows client applications to connect to Dremio Cloud.

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

Supported Authentication Methods

Connection strings can authenticate to Dremio Cloud by using a personal access token (PAT) obtained from Dremio Cloud or a JSON Web Token (JWT). You can use a PAT with or without OAuth enabled. To use a JWT, you must have OAuth enabled.

Construct a Connection String for JDBC Applications

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 username 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;username=$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.

   Set ssl to true

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

5. Add the ID of the project that you are connecting to.

   Set the project ID

   jdbc:dremio:direct=sql.dremio.cloud:443;token_type=personal_access_token;password=<personal-access-token>;username=;ssl=true;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.

   Set engine name

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

Encryption Properties