Connect to Azure Data Lake Storage Data in DBeaver

The CData JDBC Driver for Azure Data Lake Storage implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Azure Data Lake Storage data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Azure Data Lake Storage Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
2. In the Driver Name box, enter a user-friendly name for the driver.
3. To add the .jar, click Add File.
4. In the create new driver dialog that appears, select the cdata.jdbc.adls.jar file, located in the lib subfolder of the installation directory.
5. Click the Find Class button and select the ADLSDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.adls.ADLSDriver.
6. Add jdbc:adls: in the URL Template field.

Create a Connection to Azure Data Lake Storage Data

Follow the steps below to add credentials and other required connection properties.

1. In the Databases menu, click New Connection.
2. In the Create new connection wizard that results, select the driver.
3. On the next page of the wizard, click the driver properties tab.

4. Enter values for authentication credentials and other properties required to connect to Azure Data Lake Storage.

   Authenticating to a Gen 1 DataLakeStore Account

   Gen 1 uses OAuth 2.0 in Azure AD for authentication.

   For this, an Active Directory web application is required. You can create one as follows:

   1. Sign in to your Azure Account through the .
   2. Select "Azure Active Directory".
   3. Select "App registrations".
   4. Select "New application registration".
   5. Provide a name and URL for the application. Select Web app for the type of application you want to create.
   6. Select "Required permissions" and change the required permissions for this app. At a minimum, "Azure Data Lake" and "Windows Azure Service Management API" are required.
   7. Select "Key" and generate a new key. Add a description, a duration, and take note of the generated key. You won't be able to see it again.

   To authenticate against a Gen 1 DataLakeStore account, the following properties are required:

   • Schema: Set this to ADLSGen1.
   • Account: Set this to the name of the account.
   • OAuthClientId: Set this to the application Id of the app you created.
   • OAuthClientSecret: Set this to the key generated for the app you created.
   • TenantId: Set this to the tenant Id. See the property for more information on how to acquire this.
   • Directory: Set this to the path which will be used to store the replicated file. If not specified, the root directory will be used.

   Authenticating to a Gen 2 DataLakeStore Account

   To authenticate against a Gen 2 DataLakeStore account, the following properties are required:

   • Schema: Set this to ADLSGen2.
   • Account: Set this to the name of the account.
   • FileSystem: Set this to the file system which will be used for this account.
   • AccessKey: Set this to the access key which will be used to authenticate the calls to the API. See the property for more information on how to acquire this.
   • Directory: Set this to the path which will be used to store the replicated file. If not specified, the root directory will be used.

   Below is a typical connection string:

   jdbc:adls:Schema=ADLSGen2;Account=myAccount;FileSystem=myFileSystem;AccessKey=myAccessKey;

Query Azure Data Lake Storage Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.