Label*

Default Value: N/A
Example: Azure Synapse SQL Active Directory Account

String

N/A

Specify a unique label for the account.

Account properties*

Hostname*

Default Value: N/A
Example: snpqazzuresynapse.sql.azuresynapse.net

String/Expression

N/A

Specify the server's address to which you need to connect.

Port number*

Default Value: N/A
Example: 1433

Integer/Expression

N/A

Specify the port number of the database server to which you need to connect.

Database name*

Default Value: N/A
Example: snapsdb

String/Expression

N/A

 Specify the name of the database to which you need to connect.

Username

Default Value: N/A
Example: snapadmin@sl.onmicrosoft.com

String/Expression

N/A

Specify the username that is allowed to connect to the database.
This username is used as the default username when retrieving connections and must be valid to set up the data source.

Password

Default Value: N/A
Example: P#2,nxu0oiX2&?

String/Expression

N/A

Specify the password used to connect to the data source.
This password is used as the default password when retrieving connections and must be valid to set up the data source.

JDBC JARs

Use this field set to specify the JDBC JAR files to be loaded.  Add each JAR file in a separate row.

JDBC driver

Default Value: N/A
Example: mssql-jdbc-11.2.0.jre11.jar

String

N/A

Specify the driver to use for your application. By default, the latest JDBC driver 12.2.0.jre11 is bundled with the Azure Synapse SQL Account. However, you can manually upload a custom JAR file.

JBDC driver class*

Default Value: com.microsoft.sqlserver.jdbc.SQLServerDriver
Example: com.microsoft.sqlserver.jdbc.SQLServerDriver

String

N/A

Specify the fully qualified name of the driver class to be used for connecting to the server.

Trust all certificates

Default Value: Deselected

Checkbox

N/A

Select this checkbox if all SSL certificates are to be accepted for connecting to the database.

External location

Default Value: None
Example: Blob Storage

Dropdown list

N/A

Select one of the following options to set the external location for staging data:

• None: Data is not staged on an external location.

• Blob Storage: Data is stored in Azure Blob Storage.

• Azure Data Lake Gen2: Data is stored in ADLS.

External storage endpoint

Default Value: N/A
Example: 
blob.core.windows.net (for Blob Storage)
dfs.core.windows.net (for ADLS Gen2)

String/Expression

Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location.

Specify the endpoint path for the selected external location. 

Storage Account

Default Value: N/A
Example: adlsgen2v02

String/Expression

Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location.

Specify your Account name to access the selected Azure external storage location. 

Azure container

Default Value: N/A
Example: hrdepartment

String/Expression

Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location.

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

Azure folder

Default Value: N/A
Example: salaries

String/Expression

Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location.

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

Azure auth type

Default Value: Access Key
Example: Shared Access Signature

Dropdown list

Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location.

Select the authentication type to use for accessing the selected Azure external storage location. Then, provide the values for Azure Identify and Azure Secret fields or the selected authentication type. Available options are:

• Access Key

• Shared Access Signature

• Managed Identity

Learn more about authentication types: COPY INTO (Transact-SQL)  in Microsoft Docs.

Azure identity

Default Value: N/A
Example: Storage Account Key

String/Expression

Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location.

Specify the Azure Identity to access the selected external storage location.

• If the Azure Auth Type is:

  • Access Key, then the Azure Identity must be a constant with a value of Storage Account Key.

  • Shared Access Signature, then the Azure Identity must be a constant with a value of Shared Access Signature.

  • Managed Identity, then the Azure Identity must be a constant with a value of Managed Identity.

Azure secret

Default Value: N/A
Example: UvhVF65Bukk9hVF65BuUvhVF

String/Expression

Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location.

Specify the Azure Secret corresponding to the selected authentication type. 

• If the Azure Auth Type is:

  • Shared Access Signature, then the Azure Secret must be the Shared Access Signature that provides delegated access to resources in your storage account.
    Minimum permissions required are READ and LIST.

  • Access Key, then the Azure Secret must be the Storage Account Key value.

Learn more about the expected values for this field.: COPY INTO (Transact-SQL) in Microsoft Docs.

Enable error file support

Default Value: Deselected

Checkbox

N/A

Select this checkbox to specify the directory within the COPY statement where the rejected rows and the corresponding error file should be written.

Error file Azure folder

String/Expression

Appears when you select Error file Azure folder.

Specify a valid path to a folder in the Azure container. You can specify the full path from the storage.

Use new Azure account for error file

Default Value: Deselected

Checkbox

Appears when you select Error file Azure folder.

Select this checkbox if you need to configure a new account.
Deselect this checkbox if the error file is in the same Azure storage account as configured.

Error file external location

Default Value: Blob Storage
Example: Azure Data Lake Gen2

Dropdown list

Appears when you select Use new Azure account for error file.

Choose either of the following external locations where the files containing the data is staged:

• Blob Storage

• Azure Data

External storage endpoint

Default Value: N/A
Example:

• blob.core.windows.net

• dfs.core.windows.net

String/Expression

Appears when you select Use new Azure account for error file.

Specify the endpoint in your external location path.

Error file storage account

Default Value: N/A
Example: snaps_strg_account

String/Expression

Appears when you select Use new Azure account for error file.

Specify a valid Azure

Error file Azure container

Default Value: N/A
Example: snaps_container

String/Expression

Appears when you select Use new Azure account for error file.

Specify a valid Azure Container to use for staging data.

Error file Azure auth type

Default Value: Access Key
Example: Managed Identity

Dropdown list

Appears when you select Use new Azure account for error file.

Choose the athorization type to access the error file in Azure Synapse:

• Access Key

• Shared Access Signature

• Managed Identity

Error file Azure identity

Default Value: N/A
Example: <Encrypted>

String/Expression

Appears when you select Use new Azure account for error file.

Specify the Azure Identity that is part of the credential that specifies the authentication mechanism to access the external storage account.

Error file Azure secret

Default Value: N/A
Example: <Encrypted>

String/Expression

Appears when you select Use new Azure account for error file.

Secret is part of the credential that specifies the authentication mechanism to access the external storage account

Advanced properties

Auto commit

Default Value: Selected

Checkbox/Expression

N/A

Select this checkbox to commit each batch immediately after it is executed. If the Snap fails, only the batch being executed at that moment is rolled back.

Deselect this checkbox to commit the execution output only after the execution of all batches is complete. If the Snap fails, the entire transaction is rolled back, unless the Snap finds invalid input data before it sends the insert request to the server, and routes the error documents to the Error view.

Batch size*

Default Value: 50
Example: 60

Integer/Expression

N/A

Specify the number of statements to execute at a time.

Fetch size*

Default Value: 100
Example: 80

Integer/Expression

N/A

Specify the number of rows to fetch at a time when executing a query.
Large values could cause the server to run out of memory.

Max pool size*

Default Value: 50
Example: 60

Integer/Expression

N/A

Specify the maximum number of connections a pool must maintain at a time.

Max lifetime (minutes)*

Default Value: 30
Example: 50

Integer/Expression

N/A

Specify the maximum lifetime (in minutes) of a connection in the pool.

Idle timeout (minutes)*

Default Value: 5
Example: 8

Integer/Expression

N/A

Specify the maximum time period (in minutes) a connection is allowed to sit idle in the pool.

A value of 0 indicates that idle connections are never removed from the pool.

Checkout timeout (milliseconds)*

Default Value: 10000
Example: 8000

Integer/Expression

N/A

Specify the timeout (in milliseconds) to wait for a connection to be available when the pool is exhausted.

A value of zero waits infinitely—an exception is thrown after the wait time has expired.

URL properties

Use this field set to define additonal URL properties to use if any.

URL property name

String/Expression

N/A

Specify a name for the URL property if any.

URL property value

String/Expression

N/A

Specify a value for the URL property name.