Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
absoluteUrltrue
excludeOlder Versions|Additional Resources|Related Links|Related Information

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 pipelinesPipelines, 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 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.
Warning

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


Note
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 Pipeline parameters.

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


Account Types

Note

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

Azure SQL Account

Expand
titleAccount 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.

Note

Select queries are not batched.


Warning

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.

Warning

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

Expand
titleAccount Settings

With the Dynamic Account, you can specify the Account properties as expressions referencing pipeline 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.

Note

Select queries are not batched.


Warning

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.

Warning

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

Expand
titleAccount 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


Azure SQL Active Directory Dynamic Account

Expand
titleAccount Settings

With the Dynamic Account, you can specify the Account properties as expressions referencing pipeline 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



Insert excerpt
Azure SQL Snap Pack
Azure SQL Snap Pack
nopaneltrue