Microsoft Azure Synapse Analytics

Dremio supports integrations with organizations using Azure Synapse Analytics dedicated SQL pools via the external source.

Requirements

• Dremio v19.3+

Configuring Microsoft Azure Synapse Analytics as a Source

1. On the Datasets page, to the right of Sources in the left panel, click .
2. In the Add Data Source dialog, under Databases, select Microsoft Azure Synapse Analytics.

General

Under Name, enter the name to identify the data source in Dremio. The name cannot include the following special characters: /, :, [, or ].

Connection

• Under Host, enter the URL for your dedicated SQL pool, which typically ends in .sql.azuresynapse.net.
• Under Port (optional), enter the port required to access the data source.
• Under Database, enter the database's name. Only this database is accessed by Dremio.

Authentication

Choose an authentication method:

• No Authentication: Dremio does not attempt to provide any authentication when connecting with the SQL pool.
• Master Credentials: Dremio must provide a specified username and password in order to access the SQL pool.
  • Username: Enter the Microsoft Azure Synapse Analytics username.
  • Password:

    • Dremio: Provide the Microsoft Azure Synapse Analytics password in plain text. Dremio stores the password.

    • Azure Key Vault: Provide the URI for the Azure Key Vault secret that stores the Microsoft Azure Synapse Analytics password. The URI format is https://<vault_name>.vault.azure.net/secrets/<secret_name> (for example, https://myvault.vault.azure.net/secrets/mysecret).

      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 Microsoft Azure Synapse Analytics password, 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 Microsoft Azure Synapse Analytics password in the correct format in the provided field.

Select the Encrypt connection option to encrypt the connection to Microsoft Azure Synapse Analytics. Clear the checkbox to disable encryption.

Advanced Options

The following settings control more advanced functionalities in Dremio.

• Advanced Options
  • Show only the initial database used for connecting - This restricts Dremio's access only to a default database as specified on the General table.
  • Record fetch size - Number of records to fetch at once. Set to 0 (zero) to have Dremio automatically decide. The default value is 10.
  • Maximum idle connections - The maximum number of idle connections to keep.
  • Connection idle time (s) - Idle time, in seconds, before a connection is considered for closure.
  • Query timeout (s) - The timeout, in seconds, for query execution before it is canceled. Set to 0 for no timeout.
• Encryption
  • Verify server certificate - Forces Dremio to verify the server's certificate using the distinguished name.
  • SSL/TLS server certificate distinguished name - Specifies the location for the certificate server, which must be set to *.sql.azuresynapse.net.
• Connection Properties
  • Name - The unique name for any custom properties.
  • Value - The value associated with the custom property.

Reflection Refresh

This tab controls the frequency of reflection refreshes or the timespan for expiration for any queries performed using this data source.

• Never refresh - Prevents any query reflections associated with this source from refreshing.
• Refresh every - Sets the time interval by which reflections for this source are refreshed. This may be set to hours, days, and weeks.
• Never expire - Prevents any query reflections associated with this source from expiring.
• Expire after - Sets the time after a reflection is created that it then expires and can no longer be used for queries. This may be set to hours, days, and weeks.

Metadata

This tab offers settings that control how dataset details are fetched and refreshed.

• Dataset Handling
  • Remove dataset definitions if underlying data is unavailable - If this box is not checked and the underlying files under a folder are removed or the folder/source is not accessible, Dremio does not remove the dataset definitions. This option is useful in cases when files are temporarily deleted and put back in place with new sets of files.
• Metadata Refresh
  • Dataset Discovery
    • Fetch every - Specifies the time interval by which Dremio fetches object names. This can be set by minutes, hours, days, and weeks.
  • Dataset Details
    • Fetch mode - Restricts when metadata is retrieved.
    • Fetch every - Specifies the time interval by which metadata is fetched. This can be set by minutes, hours, days, and weeks.
    • Expire after - Specifies the timespan for when dataset details expire after a dataset is queried. This can be set by minutes, hours, days, and weeks.

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 a Microsoft Azure Synapse Analytics Source

To update a Microsoft Azure Synapse Analytics 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 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 Microsoft Azure Synapse Analytics as a Source.
4. Click Save.

Deleting a Microsoft Azure Synapse Analytics 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 a Microsoft Azure Synapse Analytics 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 source you want to remove 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.

Predicate Pushdowns

Dremio delegates the execution of these expressions and functions to the database being queried, often dramatically improving query performance. It can also offload entire SQL queries that include one or more of these expressions and functions.

%, *, +, -, /
<, <=, <>, =, >, >=, !=
AND, NOT, OR, ||
ABS
ACOS
ADD_MONTHS
ASIN
ATAN
ATAN2
AVG
CAST
CEIL
CEILING
CHAR_LENGTH
CHARACTER_LENGTH
CONCAT
COS
COT
DATE_ADD
DATE_SUB
DATE_TRUNC_DAY
DATE_TRUNC_HOUR
DATE_TRUNC_MINUTE
DATE_TRUNC_MONTH
DATE_TRUNC_YEAR
DEGREES
E
EXP
EXTRACT_DAY
EXTRACT_DOW
EXTRACT_DOY
EXTRACT_HOUR
EXTRACT_MINUTE
EXTRACT_MONTH
EXTRACT_QUARTER
EXTRACT_SECOND
EXTRACT_WEEK
EXTRACT_YEAR
FLOOR
IS DISTINCT FROM
IS NOT DISTINCT FROM
IS NOT NULL
IS NULL
LAST_DAY
LCASE
LEFT
LENGTH
LIKE
LN
LOCATE
LOG
LOG10
LOWER
LPAD
LTRIM
MAX
MIN
MOD
MONTH
PI
POSITION
POW
POWER
RADIANS
RAND
REPLACE
REVERSE
RIGHT
ROUND
RPAD
RTRIM
SIGN
SIN
SQRT
SUBSTR
SUBSTRING
SUM
TAN
TIMESTAMPADD_DAY
TIMESTAMPADD_HOUR
TIMESTAMPADD_MINUTE
TIMESTAMPADD_MONTH
TIMESTAMPADD_QUARTER
TIMESTAMPADD_SECOND
TIMESTAMPADD_YEAR
TIMESTAMPDIFF_DAY
TIMESTAMPDIFF_HOUR
TIMESTAMPDIFF_MINUTE
TIMESTAMPDIFF_MONTH
TIMESTAMPDIFF_QUARTER
TIMESTAMPDIFF_SECOND
TIMESTAMPDIFF_WEEK
TIMESTAMPDIFF_YEAR
TO_DATE
TRIM
TRUNC
TRUNCATE
UCASE
UPPER
YEAR

Running Queries Directly on Azure Synapse Analytics Through Dremio

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