Connect to Azure Data Lake Storage Data in DBeaver

The CData ODBC Driver for Azure Data Lake Storage enables access to live data from Azure Data Lake Storage under the ODBC standard, allowing you work with Azure Data Lake Storage data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage Azure Data Lake Storage data with visual tools in DBeaver like the query browser.

The CData ODBC drivers offer unmatched performance for interacting with live Azure Data Lake Storage data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to Azure Data Lake Storage, the driver pushes supported SQL operations, like filters and aggregations, directly to Azure Data Lake Storage and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can manage and analyze Azure Data Lake Storage data.

Connect to Azure Data Lake Storage

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

Authenticating to a Gen 1 DataLakeStore Account

Gen 1 uses OAuth 2.0 in Entra ID (formerly 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 "Entra ID" (formerly Azure AD).
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.

Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.

👁 Setting the Map To WVarchar property

Connecting to the Azure Data Lake Storage ODBC Data Source in DBeaver

1. Open the DBeaver application and in the Database menu, select the New Database Connection option. 👁 Creating a new Database Connection
   
2. In the 'Connect to a database' window, select ODBC and click Next. 👁 Creating a new Database Connection
   
3. In the Database/Schema field, enter the DSN name (CData Azure Data Lake Storage Source by default). It will be automatically added to the JDBC URL as well.
4. Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful. 👁 Successfully tested connection
   

Query Azure Data Lake Storage Data

You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.

👁 Viewing data (Salesforce is shown)

Free Trial & More Information

At this point, you have connected to live Azure Data Lake Storage data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live Azure Data Lake Storage data DBeaver today.