/
ELT Azure Synapse Account

ELT Azure Synapse Account

Owned by Anand Vedam
Last updated: May 09, 2024 by Gouri Bhagchandani

1In this article

Overview

You can use the ELT Database Account to connect ELT Snaps with an Azure Synapse target instance. This account enables you to write transformed data to a target Azure Synapse database hosted in a Microsoft Azure cloud location. The cloud location where the database is hosted is indicated in the JDBC URL for Azure Synapse—jdbc:sqlserver://<yourserver>.database.windows.net.

The ELT Snap Pack does not support mixed accounts from different types of databases in the same Pipeline. For example, a Pipeline in which some Snaps are connecting to the Azure Synapse database cannot have other Snaps connecting to a Redshift database.

Prerequisites

  • A valid Azure Synapse account.

  • Certified JDBC JAR File: mssql-jdbc-11.2.1.jre11.jar

    Using Alternate JDBC JAR File Versions

    We recommend that you let the ELT Snaps use this JAR file version. However, you may use a different JAR file version of your choice.

Limitations

The ELT Azure Synapse Account supports the following:

  • Only provisioned clusters of Azure Synapse, but not in Serverless mode.
  • External locations: 
    • Blob Storage: https://.blob.core.windows.net//
    • ADLS Gen2: https://.dfs.core.windows.net// 

Known Issue

  • When you use the auto-fill feature in the Google Chrome browser to fill ELT Snap account credentials—such as user names, passwords, client secrets, auth codes and tokens, secret keys, and keystores, the accounts, and hence the Pipelines fail. This is because the browser overwrites the field values with its own encrypted values that the SnapLogic Platform cannot read. SnapLogic recommends that you do not auto-save your Snap account credentials in the Chrome browser, delete any credentials that the browser has already saved for elastic.snaplogic.com, and then perform ONE of the following actions:
    • Option 1: Click  that appears in the address bar after you submit your login credentials at elastic.snaplogic.com, and then click Never. 
    • Option 2: Disable the Offer to save Passwords option at chrome://settings/passwords while working with your SnapLogic Pipelines. If you disable this option, your Chrome browser will not remember your passwords on any other website.

Account Settings

While you configure your Snap Account...

  • Asterisk ( * ) indicates a mandatory field.

  • Suggestion icon ( ) indicates a list that is dynamically populated based on the configuration.

  • Expression icon ( ) indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon () indicates that you can add fields in the fieldset.

  • Remove icon () indicates that you can remove fields from the fieldset.

ParameterField Dependency

Description

Label*None.

Required. Unique user-provided label for the account.

Default Value: N/A

Example: ELT AZ SY Blob Account

Account Properties*

Use this fieldset to configure the information required to establish a JDBC connection with the account.

This fieldset consists of the following fields:

  • Database Type
  • Download JDBC Driver Automatically
  • JDBC JAR(s) and/or ZIP(s)
  • JDBC Driver Class
  • JDBC URL
  • Username
  • Password
  • Default Database Name
Database Type*None.

Select the target data warehouse into which the queries must be loaded, that is Azure Synapse. This activates the following fields:

  • External Location

Default Value: N/A

Example: Azure Synapse

Download JDBC Driver AutomaticallyCheckbox

Select this checkbox to allow the Snap account to download the certified JDBC Driver for Azure Synapse. The following fields are disabled when you select this checkbox.

  • JDBC JAR(s) and/or ZIP(s)
  • JDBC driver class

To use a JDBC Driver of your choice, clear this checkbox, upload (to SLDB), and choose the required JAR files in the JDBC JAR(s) and/or ZIP(s): JDBC Driver field. 

Use of Custom JDBC JAR version

You can use a different JAR file version outside of the recommended listed JAR file versions.

Default Value: Not Selected

Example: Selected

JDBC JAR(s) and/or ZIP(s)Required when the Download JDBC Driver Automatically checkbox is not selected.

Upload the JDBC driver and other JAR files that you want to use into SLDB. Click  to add a new row. Add each JDBC JAR file in a separate row. See Downloading Microsoft JDBC Driver for more information about JDBC drivers and download the appropriate driver for your account.

If you are using Azure Active Directory password based authentication on the older Snap Pack version, you could encounter an error while using ELT based pipelines in Azure Synapse. This error is occurring due to absence of the following two jars in the ELT Snap Pack. Add these two JAR files to the list that you want to use to rectify the issue:

  • MSAL4J (Microsoft Authentication Library for Java) during compile time

  • Nimbusds oauth for runtime.

However, this error would not occur if you are on the 430patches18196 Snap Pack version.


Default Value: N/A

Example: mssql-jdbc-8.4.1.jre8.jar

JDBC driver class*Required when the Download JDBC Driver Automatically checkbox is not selected.

Specify the driver class to use for your application. 

We recommend that you use com.microsoft.sqlserver.jdbc.SQLServerDriver to suit your Azure Synapse database, as other classes and methods may change due to future enhancements.

Default Value: N/A

Example: com.microsoft.sqlserver.jdbc.SQLServerDriver

JDBC URL*None.

Enter the JDBC driver connection string that you want to use in the syntax provided below. See Microsoft's Connection strings for SQL pools in Azure Synapse for more information. 

  • jdbc:sqlserver://endpoint:port;database=<databaseName>;<parameter1=value1>;<parameter2=value2>;

Alternatively, you can make use of the Username, Password, and Database Name fields, along with the Advanced Properties > URL Properties fieldset to provide the parameters required for building your JDBC URL. See Passing your JDBC URL for more information.

Avoid passing Password inside the JDBC URL

If you specify the password inside the JDBC URL, it is saved as-is and not encrypted. We recommend passing your password using the Password field provided, instead, to ensure that your password is encrypted.

Default Value: N/A

Example: jdbc:sqlserver://yourserver.database.windows.net:1433;database=yourdatabase;user={your_user_name};password=your_password_here};encrypt=true;trustServerCertificate
=false;hostNameInCertificate=*.database.windows.net;loginTimeout=300;

Default Database Name*None.

Enter the name of the database to use by default. This database is used if you do not specify one in the ELT Load, ELT Select, ELT Insert-Select, or ELT Merge Into Snaps. 

Default value: N/A

Example: EMPLOYEEDB

External Location
Database Type is Azure Synapse.

Select the source data location from which to load data into the target database. You must configure this field if you want to use the ELT Load Snap. 

Available options are:

  • None
  • Blob Storage
  • Azure Data Lake Gen2

Selecting an option other than None in this field activates the following fields:

  • External Storage Endpoint
  • Storage Account
  • Azure Container
  • Azure Folder
  • Azure Auth Type
  • Azure Identity
  • Azure Secret

Default value: None

Example: Azure Data Lake Gen2

External Storage Endpoint
Database Type is Azure Synapse.

Enter the endpoint path for the selected external location. You must configure this field if you want to use the ELT Load Snap.

Default value: N/A

Example: .blob.core.windows.net (for Blob Storage), .dfs.core.windows.net (for ADLS Gen2)

Storage Account
Database Type is Azure Synapse. External Location is Blob Storage or Azure Data Lake Gen2.

Enter your Account name to access the selected Azure external storage location. You must configure this field if you want to use the ELT Load Snap.

Default value: N/A

Example: adlsgen2v02

Azure ContainerDatabase Type is Azure Synapse. External Location is Blob Storage or Azure Data Lake Gen2.

Enter the name of the container in the Azure storage account.

Azure Container is not applicable to the Redshift database.

Default value: N/A

Example: hrdepartment

Azure FolderDatabase Type is Azure Synapse. External Location is Blob Storage or Azure Data Lake Gen2.

Enter the relative path for the folder within the container specified above. Leave this field blank to use all the folders in the specified container. </