Versions Compared

Key

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

...

Field Name*

Field Type

Description

Label*

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

String

Specify a unique label for the account.

Account properties*

Enter the information to create a connection to the database.

Hostname*

Default Value: N/A
Example: test.database.windows.net

String

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

Port Number*

Default Value: 3306
Example: 8080

Integer

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

Database name*

Default Value: N/A
Example: DB1

String

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

Authentication Mode*

 

Default Value: Active Directory Password
Example: Active Directory Service Principal

Dropdown list

Select either of the following options for Azure SQL Authentication:

  • Active Directory Password: Provide Username and Password for authentication.

  • Active Directory Service Principal: Provide Client ID and Client Secret from service principals for authentication.

  • An Azure Active Directory (Azure AD) service principal is the local representation of an application object in a single tenant or directory. 

  • Service principals define who can access the application, and what resources the application can access.

Username

Default Value: N/A
Example: sladmin

String

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

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.

Trust all certificates

Default Value: Deselected

Checkbox

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

Advanced properties

Use this field set to specify the advanced properties.

Auto commit

Default Value: Selected

Checkbox

Select this checkbox to commit each of the batches 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 output 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.

Disable connection pooling

Default Value: Deselected

Checkbox

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 select this checkbox for Snaps that use session state, for example, creating a temporary table.

When you select the Disable Connection Pooling checkbox, the account forces the session state to close the existing connection and reopen another connection to the database for each Snap until the Pipeline is executed, which might affect the performance. Therefore, we recommend that you select the Disable Connection Pooling checkbox only when there is clear isolation between Snap executions within a Pipeline.

Batch size*

Default Value: 50
Example: 60

Integer

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.

Fetch size*

Default Value: 100
Example: 80

Integer

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

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

Max life time*

Default Value: 30
Example: 50

Integer

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.

Idle Timeout

Default Value: 5
Example: 8

Integer

Specify the maximum amount of time (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*

Default Value: 10000
Example: 100

Integer

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

If you specify 0, the Snap waits infinitely until the connection is available. Therefore, we recommend you not to specify 0 for Checkout Timeout.

URL properties

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

URL Property Name

Default Value:N/A
Example: MAX_CONCURRENCY_LEVEL

String

Specify a name for the URL property if any.

URL Property Value

Default Value: N/A
Example: 3

 

String

Specify a value for the URL property name.

...