Specify a unique label for the account.

Default value: None.

Example: Azure Synapse SQL Entra Account

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

Default value: N/A

Example: sl-synapse.sql.azuresynapse.net

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

Default value: N/A

Example: 1433

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

Default value: N/A

Example: Synapse SQL

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.

Default value: N/A

Example: mssql-jdbc-11.2.0.jre11.jar

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

Default value: com.microsoft.sqlserver.jdbc.SQLServerDriver

Example: com.microsoft.sqlserver.jdbc.SQLServerDriver

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

Default value: Deselected

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.

Default value: None

Example: Blob Storage

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

Specify the endpoint path for the selected external location.

Default value: N/A

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

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.

Default value: N/A

Example: adlsgen2v02

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

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

Default value: N/A

Example: hrdepartment

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.

Default value: N/A

Example: salaries

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.

Default value: Access Key

Example: Shared Access Signature

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.

The minimum RBAC roles required are Storage blob data contributor or Storage blob data owner for the AAD registered SQL Database server.

Default value: N/A

Example: Storage Account Key

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.

Default value: N/A

Example: UvhVF65Bukk9hVF65BuUvhVF

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

The error file only applies to CSV file formats.

Default value: Deselected

Appears when you select Enable error file support.

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

Default value: N/A

Appears when you select Enable error file support.

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.

Default value: Deselected

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 Lake Gen2

Default value: Blob Storage

Example: Azure Data Lake Gen2

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

Specify the endpoint in your external location path.

Default value: N/A

Example: blob.core.windows.net or dfs.core.windows.net

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

Specify a valid Azure Storage Account.

Default value: N/A

Example: snaps_strg_account

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

Specify a valid Azure Container to use for staging data.

Default value: N/A

Example: snaps_container

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

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

• Access Key
• Shared Access Signature
• Managed Identity

Default value: Access Key

Example: Managed Identity

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.

Default value: N/A

Example: <Encrypted>

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.

Default value: N/A

Example: <Encrypted>

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.

Default value: Selected

Specify the number of statements to execute at a time.

Select queries are not batched.

Using a large batch size could use up the JDBC placeholder limit of 2100.

Default value: 50

Example: 60

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.

Default value: 100

Example: 80

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

Default value: 50

Example: 60

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

Ensure that the value you enter is a few seconds shorter than any database or infrastructure-imposed connection time limit. A value of 0 indicates an infinite lifetime, subject to the Idle Timeout value. An in-use connection is never retired. Connections are removed only after they are closed.

Default value: 30

Example: 50

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.

Default value: 5

Example: 8

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.

Default value: 10000

Example: 8000

Specify a name for the URL property if any.

Default value: N/A

Specify the value for the URL property.

Default value: N/A