Configuring Azure SQL Accounts

On this Page

This account is used by the Snaps in the Azure SQL Snap Pack.

You can create an account from Designer or Manager. In Designer, when working on Pipelines, every Snap that needs an account prompts you to create a new account or use an existing account. The accounts can be created in or used from:

  • Your private project folder: This folder contains the Pipelines that will use the account.
  • Your Project Space’s shared folder: This folder is accessible to all the users that belong to the Project Space.
  • The global shared folder: This folder is accessible to all the users within an organization in the SnapLogic instance.

Account Configuration

In Manager, you can navigate to the required folder and create an account in it (see Accounts). To create an account for binary files:

  1. Click Create, then select any Azure SQL Account:
    • Azure SQL Account
    • Azure SQL Dynamic Account
    • Azure SQL Active Directory Account

    • Azure SQL Active Directory Dynamic Account

  2. Supply an account label.
  3. Supply the account properties for your database.
  4. (Optional) Supply additional information on this account in the Notes field of the Info tab.
  5. Click Apply.

Avoid changing account credentials while Pipelines using them are in progress. This may lead to unexpected results, including locking the account.


If the Snap fails to connect to the database, it will retry three more times. 

You can Validate an account connection when creating a Azure SQL/Active Directory Account but not when creating a Azure SQL/Active Directory Dynamic Account because the account properties of a dynamic account are provided dynamically as Pipeline parameters.

The difference between Azure SQL/Active Directory Account and Azure SQL/Active Directory Dynamic Account is that in the latter you can specify the Account properties as expressions referencing Pipeline parameters.


Account Types

Active Directory-based authentication is not supported in the Azure SQL Bulk Extract Snap.

Azure SQL Account

 Account Settings

Label

Required. User provided label for the account instance.

Account properties

Required. Enter in the information to create a connection to the database.

Hostname

Required. The server's address to connect to.

Default value: [None]

Port Number

Required. The database server's port to connect to.

Default value: 3306

Database name

Required. The database name to connect to.

Default value: [None]

Username


Username that is allowed to connect to the database. Username will be used as the default username when retrieving connections. The username must be valid in order to set up the data source.

Default value: [None]

Password


Password used to connect to the data source. Password wil be used as the default password when retrieving connections. The password must be valid in order to set up the data source.

Default value: [None]

JDBC Jars

List of JDBC Jar files to be loaded.

Example: ../shared/sqljdbc4-2.0.jar

JDBC Driver Class

Required. JBDC driver class name to use.

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

Trust all certificates

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

Default value: Not selected

Azure storage account name

Required. Name with which Azure Storage was created. The Bulk Load Snap automatically appends the '.blob.core.windows.net' domain to the value of this property.

Azure storage account key

Required. Key generated by Azure for this account.

Azure storage container name

Required. Name of an existing container.
Advanced properties

Auto commit

When selected, each of the batches is committed immediately after it is executed. If the Snap fails, only the batch being executed at that moment is rolled back.

When deselected, the Snap execution output is committed only after all the batches are executed. 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

Disable connection pooling

Select this checkbox to prevent the sharing of session state.

Connection pooling keeps the connections active. When the Snap uses a connection and creates a table during execution, the table gets locked and is not released even after the Snap is executed and the connection is returned to the pool. If another Snap or the same Snap uses the same connection from the pool and reads the metadata of the same table, it displays an error that the resource is locked.

We recommend you to select this checkbox for Snaps that use session state, for example, creating a temporary table.

Default Value: Deselected

Batch size

Required. 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

Fetch size

Required. 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

Max pool size

Required. Maximum number of connections a pool will maintain at a time.

Default value: 50

Max life time

Required. Maximum lifetime 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

Idle Timeout

Required. The maximum amount of time 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

Checkout timeout

Required. Number of milliseconds to wait for a connection to be available when the pool is exhausted. Zero waits forever. An exception will be thrown after the wait time has expired.

Default value: 10000

URL Properties

URL property name

URL property name

Default value: [None]

URL property value

URL property value

Default value: [None]

Account Encryption

Standard Encryption

If you are using Standard Encryption, the High sensitivity settings under Enhanced Encryption are followed.


Enhanced Encryption

If you have the Enhanced Account Encryption feature, the following describes which fields are encrypted for each sensitivity level selected for this account.

Account:

  • High: Password, Azure storage account key
  • Medium + High: Username, Password, Azure storage account key
  • Low + Medium + High: Hostname, Database name, Username, Password, Azure storage account key, Url property value

Azure SQL Dynamic Account

 Account Settings

With the Dynamic Account, you can specify the Account properties as expressions referencing Pipeline parameters.

Account Settings

Label

Required. User provided label for the account instance.

Account properties

Required. Enter in the information to create a connection to the database.

Hostname

Required. The server's address to connect to.

Default value: [None]

Port Number

Required. The database server's port to connect to.

Default value: 3306

Database name

Required. The database name to connect to.

Default value: [None]

Username


Username that is allowed to connect to the database. Username will be used as the default username when retrieving connections. The username must be valid in order to set up the data source.

Default value: [None]

Password


Password used to connect to the data source. Password wil be used as the default password when retrieving connections. The password must be valid in order to set up the data source.

Default value: [None]

JDBC Jars

List of JDBC Jar files to be loaded.

Example: ../shared/sqljdbc4-2.0.jar

JDBC Driver Class

Required. JBDC driver class name to use.

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

Trust all certificates

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

Default value: Not selected

Azure storage account name

Required. Name with which Azure Storage was created. The Bulk Load Snap automatically appends the '.blob.core.windows.net' domain to the value of this property.

Azure storage account key

Required. Key generated by Azure for this account.

Azure storage container name

Required. Name of an existing container.
Advanced properties

Auto commit

When selected, each of the batches is committed immediately after it is executed. If the Snap fails, only the batch being executed at that moment is rolled back.

When deselected, the Snap execution output is committed only after all the batches are executed. 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

Batch size

Required. 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

Fetch size

Required. 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

Max pool size

Required. Maximum number of connections a pool will maintain at a time.

Default value: 50

Max life time

Required. Maximum lifetime 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

Idle Timeout

Required. The maximum amount of time 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

Checkout timeout

Required. Number of milliseconds to wait for a connection to be available when the pool is exhausted. Zero waits forever. An exception will be thrown after the wait time has expired.

Default value: 10000

URL Properties

URL property name

URL property name

Default value: [None]

URL property value

URL property value

Default value: [None]

Account Encryption

Standard Encryption

If you are using Standard Encryption, the High sensitivity settings under Enhanced Encryption are followed.


Enhanced Encryption

If you have the Enhanced Account Encryption feature, the following describes which fields are encrypted for each sensitivity level selected for this account.

Account:

  • High: Password, Azure storage account key
  • Medium + High: Username, Password, Azure storage account key
  • Low + Medium + High: Hostname, Database name, Username, Password, Azure storage account key, Url property value

Azure SQL Active Directory Account

 Account Settings

Label

Required. User provided label for the account instance.

Account properties

Required. Enter in the information to create a connection to the database.

Hostname

Required. The server's address to connect to.

Default value: [None]

Port Number

Required. The database server's port to connect to.

Default value: 1433

Database name

Required. The database name to connect to.

Default value: [None]

Username

 

Username that is allowed to connect to the database. Username will be used as the default username when retrieving connections. The username must be valid in order to set up the data source.

Default value: [None]

Password

 

Password used to connect to the data source. Password wil be used as the default password when retrieving connections. The password must be valid in order to set up the data source.

Default value: [None]

Trust all certificates

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

Default value: Not selected

Advanced properties 

Auto commit

When selected, each of the batches is committed immediately after it is executed. If the Snap fails, only the batch being executed at that moment is rolled back.

When deselected, the Snap execution output is committed only after all the batches are executed. 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

Disable connection pooling

Select this checkbox to prevent the sharing of session state.

Connection pooling keeps the connections active. When the Snap uses a connection and creates a table during execution, the table gets locked and is not released even after the Snap is executed and the connection is returned to the pool. If another Snap or the same Snap uses the same connection from the pool and reads the metadata of the same table, it displays an error that the resource is locked.

We recommend you to select this checkbox for Snaps that use session state, for example, creating a temporary table.

Default Value: Deselected

Batch size

Required. 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

Fetch size

Required. 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

Max pool size

Required. Maximum number of connections a pool will maintain at a time.

Default value: 50

Max life time

Required. Maximum lifetime 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

Idle Timeout

Required. The maximum amount of time 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

Checkout timeout

Required. Number of milliseconds to wait for a connection to be available when the pool is exhausted. Zero waits forever. An exception will be thrown after the wait time has expired.

Default value: 10000

URL Properties 

URL property name

URL property name

Default value: [None]

URL property value

URL property value

Default value: [None]

Account Encryption

Standard Encryption

If you are using Standard Encryption, the High sensitivity settings under Enhanced Encryption are followed.


Enhanced Encryption

If you have the Enhanced Account Encryption feature, the following describes which fields are encrypted for each sensitivity level selected per each account.

  • High: Password
  • Medium + High: Password
  • Low + Medium + High: Password

Azure SQL Active Directory Dynamic Account

 Account Settings

With the Dynamic Account, you can specify the Hostname, Username, Database nameand Password dynamically using Pipeline parameters since they support SnapLogic expressions. You will need to enable the expression-mode by clicking the  button to pass values dynamically as Pipeline parameters. 

Account Settings

Label

Required. User provided label for the account instance.

Account properties

Required. Enter in the information to create a connection to the database.

Hostname

Required. The server's address to connect to.

Default value: [None]

Port Number

Required. The database server's port to connect to.

Default value: 1433

Database name

Required. The database name to connect to.

Default value: [None]

Username


Username that is allowed to connect to the database. Username will be used as the default username when retrieving connections. The username must be valid in order to set up the data source.

Default value: [None]

Password


Password used to connect to the data source. Password wil be used as the default password when retrieving connections. The password must be valid in order to set up the data source.

Default value: [None]

Trust all certificates

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

Default value: Not selected

Advanced properties

Auto commit

When selected, each of the batches is committed immediately after it is executed. If the Snap fails, only the batch being executed at that moment is rolled back.

When deselected, the Snap execution output is committed only after all the batches are executed. 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

Batch size

Required. 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

Fetch size

Required. 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

Max pool size

Required. Maximum number of connections a pool will maintain at a time.

Default value: 50

Max life time

Required. Maximum lifetime 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

Idle Timeout

Required. The maximum amount of time 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

Checkout timeout

Required. Number of milliseconds to wait for a connection to be available when the pool is exhausted. Zero waits forever. An exception will be thrown after the wait time has expired.

Default value: 10000

URL Properties

URL property name

URL property name

Default value: [None]

URL property value

URL property value

Default value: [None]

Account Encryption

Standard Encryption

If you are using Standard Encryption, the High sensitivity settings under Enhanced Encryption are followed.


Enhanced Encryption

If you have the Enhanced Account Encryption feature, the following describes which fields are encrypted for each sensitivity level selected per each account.

  • High: Password
  • Medium + High: Password
  • Low + Medium + High: Password

Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates
4.29main15993 Stable

Enhanced the Azure SQL Account and Azure SQL Active Directory Account with the Disable connection pooling checkbox that allows you to manage session state sharing.

4.28 Patch428patches15164 Latest

Fixed an issue with the Azure SQL - Update Snap where the Snap failed with an Incorrect syntax error when a column in a table is of NVARCHAR, NCHAR, or NTEXT data type and this column is part of another NVARCHAR, NCHAR, or NTEXT data type column name and the update condition is specified as an expression.

4.28 Patch428patches15114 LatestFixed an issue with the Azure SQL - Bulk Load Snap where the decimal values lost precision when they were inserted into the database.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27main12833 Stable

Enhanced the Azure SQL - Execute Snap to invoke stored procedures.

4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
Stable

Enhances the Azure SQL - Stored Procedure to accept parameters from input documents by column keys. If the values are empty, the parameters are populated based on the column keys for easier mapping in the upstream Mapper Snap.

4.23main7430
 
Stable

Enhances the Azure SQL - Bulk Extract Snap by adding a new check box Enable UTF-8 encoding to support UTF-8 encoded characters. This check box allows the Snap to update the BCP command to read the special characters.

4.22 Patch 422Patches6751 Latest

Enhances the Azure SQL - Bulk Extract Snap by adding a new check box Enable UTF-8 encoding to support UTF-8 encoded characters. Selected by default, this check box allows the Snap to update the BCP command to read these special characters.

4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21 Patch 421patches6272 Latest

Fixes the issue where Snowflake SCD2 Snap generates two output documents despite no changes to Cause-historization fields with DATE, TIME and TIMESTAMP Snowflake data types, and with Ignore unchanged rows field selected.

4.21 Patch 421patches6144 Latest

Fixes the following issues with DB Snaps:

  • The connection thread waits indefinitely causing the subsequent connection requests to become unresponsive.
  • Connection leaks occur during Pipeline execution.
4.21 Patch421patches5864 Latest

Adds support for UTF_8 characters with BCP (bulk copy program) command to the Azure SQL Bulk Extract Snap.

4.21 PatchMULTIPLE8841 Latest

Fixes the connection issue in Database Snaps by detecting and closing open connections after the Snap execution ends. 

4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19 Patch db/azuresql8403 Latest

Fixes an issue with the Azure SQL - Update Snap wherein the Snap is unable to perform operations when:

  • An expression is used in the Update condition property.
  • Input data contain the character '?'.
4.19snaprsmrc528
 
Stable

Enhanced the error handling in PolyBase Bulk Load Snap when writing to a data warehouse. The Snap writes a new blob in the Azure container. This new blob highlights the first invalid row that caused the bulk load operation to fail.

4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Latest
  • Fixes an issue with the Azure SQL Execute Snap wherein the Snap would send the input document to the output view even if the Pass through field is not selected in the Snap configuration. With this fix, the Snap sends the input document to the output view, under the key original, only if you select the Pass through field. 
  • Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
4.16 Patch db/azuresql7179 Latest

Fixes an issue with the Azure SQL Bulk Extract Snap wherein the Snap fails to process all the metadata information of the input table and schema.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15 Patch db/azuresql6327 Latest

Replaced Max idle time and Idle connection test period properties with Max life time and Idle Timeout properties respectively, in the Account configuration. The new properties fix the connection release issues that were occurring due to default/restricted DB Account settings.

4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11 Patchazuresql4631 Latest

Fixes an issue with the Azure Polybase Bulk Load Snap that failed with "Parse error" when there was no input.

4.11 Patch db/azuresql4326 Latest
  • Fixes an issue with the Azure SQL Polybase Bulk Load Snap, that allowed the Snap to load data into a table with identity columns for Azure SQL Data Warehouse instance.
  • Fixes encoding issue when using a Windows plex, and added a "Encoding" Snap property that allows user to choose input data's encoding from UTF-8 and UTF-16.
4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10

snapsmrc414

 
Stable
  • Renamed the Azure SQL Bulk Load Snap to Polybase Bulk Load as it supports Azure SQL DW and SQL Server (starting with 2016).
  • The new Snap, Azure SQL Bulk Load is developed has been developed to carry out the bulk load function extensively for Azure SQL DB. (The old Azure Bulk Load has been renamed to Polybase BulkLoad  which works for on-premise SQL Server and Azure SQL Data Warehouse with polybase functionality).
  • Azure SQL Bulk Load, Table List, Execute, Stored ProcedureAzure SQL - Table Listand Update Snaps are released in this release.
  • Added Auto commit property to the Select and Execute Snaps at the Snap level to support overriding of the Auto commit property at the Account level.
  • Added the below accounts:
    • Azure SQL Active Directory Account

    • Azure SQL Active Directory Dynamic Account

4.9 Patch azuresql3078 Latest

Fixes an issue regarding connection not closed after login failure; Expose autocommit for "Select into" statement in PostgreSQL Execute Snap and Redshift Execute Snap

4.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.
4.8 Patch azuresql2750
Latest

Potential fix for JDBC deadlock issue.

4.8

snapsmrc398

 
Stable
  • Info tab added to accounts.
  • Database accounts now invalidate connection pools if account properties are modified and login attempts fail.
4.7 Patchazuresql2196 Latest

Fixes an issue for database Select Snaps regarding Limit rows not supporting an empty string from a pipeline parameter.

4.7

snapsmrc382

 
StableUpgraded with the latest SnapLogic Platform release.
4.6snapsmrc362
 
StableUpgraded with the latest SnapLogic Platform release.
4.5.1

snapsmrc344

 
StableUpgraded with the latest SnapLogic Platform release.
4.5

snapsmrc344

 StableUpgraded with the latest SnapLogic Platform release.