Skip to main content
Version: current [25.x]

Microsoft Azure Data Explorer

You can add a source to Dremio that is a database in Azure Data Explorer (ADX).

Prerequisites

  • Ensure that you have the URI for connecting to the ADX cluster in which the database is located.

  • Ensure that you know the name of the database that you want to add as a source.

  • Ensure that you have an application (client) ID, directory (tenant) ID, and client secret for a Microsoft Entra ID application. You must provide Dremio with the IDs and secret to allow it to access the database.

    To register a Microsoft Entra ID application and obtain the IDs and client secret:

    1. Log into Azure portal and go to Microsoft Entra ID.
    2. Select App registrations on the left.
    3. Click New registration.
    4. Specify a name for the application.
    5. Select the single-tenant account type.
    6. Leave the Redirect URI field blank.
    7. Click Register in the bottom-left corner of the page.
    8. On the Overview page for the application, copy the application (client) ID and the directory (tenant) ID, and paste them in a location that you can refer to in a later step.
    9. Select Certificates & secrets on the left under Manage.
    10. Click New client secret.
    11. Specify a description of the secret and a duration of time for the secret to be valid for.
    12. Click Add.
    13. Copy the value of the secret and paste it in a location that you can refer to in a later step.

Configuring Azure Data Explorer as a Source

To add a database that is in ADX cluster as a source in Dremio:

  1. Click the Settings icon on the in the left navbar and select Support.
  2. In the Support Keys section of the Support Settings page, add the support key plugins.jdbc.adx.enabledand toggle it on.
  3. Navigate to the Datasets page. To the right of Sources in the left panel, click This is the Add Source icon..
  4. In the Add Data Source dialog, under Databases, select Microsoft Azure Data Explorer.

General

Under Name, enter the name to use for the Azure Data Explorer source. The name cannot include the following special characters: /, :, [, or ].

Connection

  • Under Cluster URI, enter the cluster URI.
  • Under Tenant ID, enter the directory (tenant) ID.

Authentication

  • Under Application ID, enter the application (client) ID into the field.

  • Under Application Secret, select one of the following methods for providing the application secret:

    • Dremio: Provide the application secret in plain text. Dremio stores the application secret.

    • Azure Key Vault: Provide the URI for the Azure Key Vault secret that stores the application secret. The URI format is https://<vault_name>.vault.azure.net/secrets/<secret_name> (for example, https://myvault.vault.azure.net/secrets/mysecret). Dremio connects to Azure Key Vault and fetches the secret to use as the application secret. Dremio does not store the fetched secret.

      note

      To use Azure Key Vault as your application secret store, you must:
      - Deploy Dremio on Azure.
      - Complete the Requirements for Authenticating with Azure Key Vault.

      It is not necessary to restart the Dremio coordinator when you rotate secrets stored in Azure Key Vault. Read Requirements for Secrets Rotation for more information.

    • AWS Secrets Manager: Provide the Amazon Resource Name (ARN) for the AWS Secrets Manager secret that holds the application secret, which is available in the AWS web console or using command line tools.

    • HashiCorp Vault: Choose the HashiCorp secrets engine you're using from the dropdown menu and enter the secret reference for the application secret in the correct format in the provided field.

  • Under Database Name, enter the name of the database that you want to add as a source.

    note

    Names are case-sensitive.

Advanced Options

On the Advanced Options page, you can set values for these non-required options:

OptionDescription
Maximum Idle ConnectionsThe total number of connections allowed to be idle at a given time. The default maximum idle connections is 8.
Connection Idle TimeThe amount of time (in seconds) allowed for a connection to remain idle before the connection is terminated. The default connection idle time is 60 seconds.
Query TimeoutThe amount of time (in seconds) allowed to wait for the results of a query. If this time expires, the connection being used is returned to an idle state.

Reflection Refresh Options

On the Reflection Refresh page, set the policy that controls how often reflections are scheduled to be refreshed automatically, as well as the time limit after which reflections expire and are removed.

OptionDescription
Never refreshSelect to prevent automatic reflection refresh, default is to automatically refresh.
Refresh everyHow often to refresh reflections, specified in hours, days or weeks. This option is ignored if Never refresh is selected.
Never expireSelect to prevent reflections from expiring, default is to automatically expire after the time limit below.
Expire afterThe time limit after which reflections expire and are removed from Dremio, specified in hours, days or weeks. This option is ignored if Never expire is selected.

Metadata Options

On the Metadata page, you can configure settings to refresh metadata and handle datasets.

Dataset Handling

These are the optional Dataset Handling parameters.

ParameterDescription
Remove dataset definitions if underlying data is unavailableBy default, Dremio removes dataset definitions if underlying data is unavailable. Useful when files are temporarily deleted and added back in the same location with new sets of files.

Metadata Refresh

These are the optional Metadata Refresh parameters:

  • Dataset Discovery: The refresh interval for fetching top-level source object names such as databases and tables. Set the time interval using this parameter.

    ParameterDescription
    (Optional) Fetch everyYou can choose to set the frequency to fetch object names in minutes, hours, days, or weeks. The default frequency to fetch object names is 1 hour.
  • Dataset Details: The metadata that Dremio needs for query planning such as information required for fields, types, shards, statistics, and locality. These are the parameters to fetch the dataset information.

    ParameterDescription
    Fetch modeYou can choose to fetch only from queried datasets that are set by default. Dremio updates details for previously queried objects in a source. Fetching from all datasets is deprecated.
    Fetch everyYou can choose to set the frequency to fetch dataset details in minutes, hours, days, or weeks. The default frequency to fetch dataset details is 1 hour.
    Expire afterYou can choose to set the expiry time of dataset details in minutes, hours, days, or weeks. The default expiry time of dataset details is 3 hours.

Privileges

On the Privileges tab, you can grant privileges to specific users or roles. See Access Controls for additional information about privileges.

note

All privileges are optional.

  1. For Privileges, enter the user name or role name that you want to grant access to and click the Add to Privileges button. The added user or role is displayed in the USERS/ROLES table.
  2. For the users or roles in the USERS/ROLES table, toggle the checkmark for each privilege you want to grant on the Dremio source that is being created.
  3. Click Save after setting the configuration.

Updating an ADX Source

To update an ADX source:

  1. On the Datasets page, under Databases in the panel on the left, find the name of the source you want to update.
  2. Right-click the source name and select Settings from the list of actions. Alternatively, click the source name and then the The Settings icon at the top right corner of the page.
  3. In the Source Settings dialog, edit the settings you wish to update. Dremio does not support updating the source name. For information about the settings options, see Configuring Azure Data Explorer as a Source.
  4. Click Save.

Deleting an ADX Source

note

If the source is in a bad state (for example, Dremio cannot authenticate to the source or the source is otherwise unavailable), only users who belong to the ADMIN role can delete the source.

To delete an ADX source, perform these steps:

  1. On the Datasets page, click Sources > Databases in the panel on the left.
  2. In the list of data sources, hover over the name of the ADX source and right-click.
  3. From the list of actions, click Delete.
  4. In the Delete Source dialog, click Delete to confirm that you want to remove the source.
note

Deleting a source causes all downstream views that depend on objects in the source to break.

Query Pushdowns

Dremio can delegate the execution of these expressions and functions to the database being queried, often dramatically improving query performance.

-, =, +, *, /
<, <=, <>, >=, >, !=
ADD_MONTHS
AND, LIKE, NOT, OR, ||
AVG
CAST
CONCAT
COUNT *
COUNT DISTINCT
COUNT DISTINCT MULTI
COUNT MULTI
DATE_ADD
DATE_SUB
DATE_TRUNC_DAY
DATE_TRUNC_HOUR
DATE_TRUNC_MINUTE
DATE_TRUNC_MONTH
DATE_TRUNC_YEAR
FULL JOIN
INNER JOIN
IS DISTINCT FROM
IS NOT DISTINCT FROM
IS NOT NULL
IS NULL
JOIN
LAST_DAY
LEFT JOIN
MAX
MIN
MOD
RIGHT JOIN
SIGN
SORT
SUM

Running Queries Directly on Azure Data Explorer Through Dremio

Dremio users can run pass queries through Dremio to run on Azure Data Explorer. Doing so can sometimes decrease query execution times. For more information, see Querying Relational-Database Sources Directly.