Skip to end of banner
Go to start of banner

Configuring SQL Server Accounts

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 50 Next »

On this page

This account is used by the Snaps in the SQL Server 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 SQL Server:

  1. Click Create, then select SQLServer > SQL Server Account or SQLServer > SQL Server Dynamic Account.
  2. Supply an account label.

  3. Supply the Account properties, JDBC jars, Advanced properties, & URL properties for your SQL Server database. When using SQL Server Dynamic Account, you can specify the Account properties as expressions referencing pipeline parameters. You cannot use document fields under expressions for Account Properties. 

    The JDBC driver should be available in any project directory the user can access. The JDBC driver class should default to com.microsoft.sqlserver.jdbc.SQLServerDriver.
  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.

Account Types

SQL Server Account

SQL Server Dynamic Account

The difference between SQL Server Account and SQL Server Dynamic Account is that in the latter you can specify the Account properties as expressions referencing pipeline parameters.

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

Remove the port number for Windows-based authentication when connecting to an MS SQL instance with multiple or named instances. Else, SnapLogic tries to connect to the specified port without checking with the Server Browser service list.

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 Driver


Select the JDBC driver to use. A different driver binary for a driver must have a different name, the same name can not be reused for a different driver. If this property is left blank, a default JDBC driver will be loaded.

Default value: [None]

JDBC Driver Class


Required. JBDC driver class name to use.

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

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.

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: selectMethod

URL property value


URL property value

Default value: cursor

Windows-based Authentication

  • Make sure that Snaplex is running Windows (Linux is not supported). 

  • Place the latest version of sqljdbc_auth.dll in $SL_ROOT/ldlib  (c:\opt\Snaplogic\ldlib). You can find latest the version of the DLL on the Microsoft SQLServer Server JDBC Driver website.

    If you upload customized JDBC jars to the directory, the following error might occur:

    java.lang.UnsatisfiedLinkError: Native Library C:\\opt\\snaplogic\\ldlib\\sqljdbc_auth.dll already loaded in another classloader

    To fix this issue, remove all JDBC jars from the SQL server account and restart the JCC node.

  • Do not specify a port number.
  • Configure an extra property for JDBC : "IntegratedSecurity" = "true" 

 

Connecting to an MSSQL Instance

  • You can connect to a specific instance of MSSQL by using the instance name along with the server name in Hostname <server_name>/<instance_name>. 
  • Alternatively, you can define the instance name by using the URL property name, instanceName.

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

You can Validate an account connection when creating a SQL Database Account but not when creating a SQL Server Dynamic Account because the account properties of a dynamic account are provided dynamically as pipeline parameters.

Windows-based Authentication Using the NTLM Protocol

There are two ways to authenticate your Windows SQL Server connection using the NTLM protocol.

Method 1: Using the MSSql Driver jar file:

  1. Download one of the following the JAR files based on your Java version:
    1. Java 8: mssql-jdbc-7.4.1.jre8.jar (Tested and Certified by SnapLogic)
    2. Java 11: mssql-jdbc-7.4.1.jre11.jar
  2. Download the sqljdbc_auth.dll file compatible with the jar file specified above and place it in $SL_ROOT/ldlib , for example, c:\opt\Snaplogic\ldlib.
  3. In the SQL Server account Settings: 

    1. Click + next to the JDBC JARs field and upload the JAR file.

    2. Specify the JDBC Driver Class name as: com.microsoft.sqlserver.jdbc.SQLServerDriver.

    3. Add the following Url properties:

      Url property name
      Url property value
      domain

      Your domain name

      Domain name must be added as a URL property and not along with the user name.

      integratedSecuritytrue
      authenticationSchemeNTLM
    4. Click Validate and select the plex when prompted. The message "Account validation successful" is displayed.
    5. Click Apply to finish setting up NTLM-based authentication. 

Any version of the JAR files available in Microsoft Java and JDBC Support page later than the versions mentioned here can be used.

Method 2: Using the JTDI file:

  1. Download the distribution ZIP file, jtds-1.3.1-dist.zip.

  2. Extract the contents of the ZIP file and 

    1. Upload the jtdi-1.3.1.jar driver to the SnapLogic shared/jar_file folder. 

    2. Upload the ntlmauth.dll file that matches the target architecture (for a 64-bit operating system, extract the file under x64/SSO) to the  $SL_ROOT/ldlib folder, for example, c:\opt\Snaplogic\ldlib.

  3. In the SQL Server account settings: 

    1. Specify the JDBC Driver Class as net.sourceforge.jtds.jdbc.Driver.

    2. Add the following Url properties:

      Url property name
      Url property value
      Domain

      Your domain name

      Domain name must be added as a URL property and not along with the user name.

      useNTLMv2true
    3. Click Validate and select the plex when prompted. The message "Account validation successful" is displayed.
    4. Click Apply to finish setting up NTLM-based authentication. 

Active Directory Kerberos Authentication

SnapLogic supports Active Directory authentication for SQL server for the following driver JAR versions based on the Java version:

  • Java 8: mssql-jdbc-7.4.1.jre8.jar (Tested and Certified by SnapLogic)
  • Java 11: mssql-jdbc-7.4.1.jre11.jar

See Microsoft JDBC Driver for SQL Server for details.

Ensure that you have installed the correct JAR file. Also, use the following configurations in Account Settings to configure Active Directory authentication:

SnapLogic supports Active Directory authentication for SQL Server using the User impersonation method. The prerequisites are as follows:

  • In the account settings, add the following to Url property name and Url property value:

    Url property name
    Url property value
    IntegratedSecurityTrue
    AuthenticationSchemeJavaKerberos

  • In the account settings, enter your Active Directory Username and Password.

Any version of the JAR files available in Microsoft Java and JDBC Support page later than the versions mentioned here can be used.

Release 

Snap Pack Version

Date

Type

Updates

November 2024

main29029

Stable

Updated and certified against the current SnapLogic Platform release.

August 2024

438patches28829

Latest

Reinstated support for the jTDS driver in the SQL Server Snap Pack.

August 2024

main27765

Stable

Updated and certified against the current Snaplogic Platform release.

May 2024

437patches27732

Latest

Fixed an issue with the SQL Server - Select Snap configured with an Ultra task to handle temporary database unavailability. The Snap now validates the database connection to ensure that it is reestablished after temporary database outages.

May 2024

437patches27328

Latest

Fixed an issue with the SQL Server Insert Snap that caused an error when inserting the infinity value into a decimal-type column.

May 2024

437patches27091

Latest

Fixed a case-sensitivity issue with the SQL Server—Bulk Load Snap that caused a NullPointerException when retrieving the PATH environment variable in a Windows environment. This change is applicable only to Windows, as environment variables are case-sensitive in Linux.

May 2024

main26341

Stable

Updated the Delete Condition (Truncates a Table if empty) field in the SQL Server - Delete Snap to Delete condition (deletes all records from a table if left blank) to indicate that all entries will be deleted from the table when this field is blank, but no truncate operation is performed.

February 2024

436patches26177

Latest

  • Fixed an issue with the SQL Server Snap Pack that displayed an error when numeric values with scale 0 were inserted into the database with DECIMAL or NUMERIC type columns, instead of inserting the value with decimal digits truncated.

  • Fixed an issue with the SQL Server Snap Pack that displayed an error when fractional numeric values (numbers with a decimal point) were inserted into the database with an INT type column, instead of inserting the value with decimal digits truncated.

February 2024

436patches25757

Latest

Fixed an issue with the SQL Server - Insert Snap that previously displayed an error when attempting to insert a true or false value into a TinyInt datatype. The Snap now correctly inserts 1 or 0 for true or false in the table, respectively. 

February 2024

436patches25548

Latest

  • Added support for XML and spatial types (Geography and Geometry) for SQL Server Snap Pack.

  • Fixed an issue with the SQL Server - Insert Snap that displayed an error when an empty or blank string was passed as a value to an integer-type column.

Behavior change:
As part of the JOOQ upgrade done in main25112, the SQL Server-Insert Snap displayed the following error when an empty string was inserted to an integer-type column:
Caused by: java.lang.NumberFormatException: Character n is neither a decimal digit number, decimal point, nor "e" notation exponential mark
Now, the Snap inserts a null value in this scenario.

February 2024

main25112

Stable

As of main25112, the SQL Server Snap Pack no longer supports the jDTS driver. If you are using the latest SQL Server driver versions (2014 and higher), we recommend you use the driver that is bundled with the SQL Server Snap Pack. Note that the older SQL Server versions are supported as is.

November 2023

main23721

Stable

Updated and certified against the current SnapLogic Platform release.

August 2023

434patches22758

Latest

Fixed an issue with the SQL Server Stored Procedure and Table List Snaps that caused no retries to be executed even if you select the number of retries in the UI when a custom JDBC driver was used.

August 2023

434patches22579

Latest

Improved the SQL Server Bulk Load Snap to reduce the chance of causing a deadlock error.

August 2023

main22460

Stable

The SQL Server - Execute Snap now includes a new Query type field. When Auto is selected, the Snap tries to determine the query type automatically.

May 2023

433patches22090

Latest

The SQL Server Stored Procedure and SQL Server Table List Snaps now support the retry functionality.

May 2023

433patches21808

Latest

  • The SQL Server Snap Pack is upgraded to the latest version of the Microsoft JDBC Driver 12.2.0.jre11 for SQL Server:

    • Pipelines using the default JAR in the SQL server accounts might fail after the driver upgrade because the latest driver is backward-incompatible. To prevent your accounts from failing, reconfigure the URL properties field in account settings as follows:

      trustServerCertificate = true

    • Pipelines NOT using the default driver (bundled with the SQL Server Snap Pack) will not fail.
      Note: This update will be a part of the stable distribution with the GA release on August 9, 2023.
      Learn more about the SQL Server driver upgrade: FAQ for Upgrading to SQL Server JDBC Driver 12.2.0

  • Fixed an issue with the SQL Server Insert Snap that was causing performance degradation between GA release 4.32 and 4.33 if the network connection between the Groundplex and the database server was slow.

May 2023

433patches21386

 

-

The SQL Server Snap Pack is upgraded to the latest version of the Microsoft JDBC Driver 12.2.0.jre11 for SQL Server:

  • Pipelines using the default JAR in the SQL server accounts might fail after the driver upgrade because the latest driver is backward-incompatible. To prevent your accounts from failing, reconfigure the URL properties field in account settings as follows:

    trustServerCertificate = true

  • Pipelines NOT using the default driver (bundled with the SQL Server Snap Pack) will not fail.

The Microsoft JDBC Driver 12.2.0.jre11 for SQL Server included in the SQL Server Snap Pack is currently NOT available with the latest distribution. However, you can still consume this patch through 433patches21386. This update is scheduled to be included in the upcoming distribution release on July 12, 2023, and will be a part of the stable distribution with the GA release on August 9, 2023.

May 2023

433patches21119

 

Latest

Updated the Bulk Load Snap to preserve empty strings as empty strings and null as nulls.

May 2023

main21015

 

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023

main19844

 

Stable

Upgraded with the latest SnapLogic Platform release.

November 2022

431patches19263

 

Latest

The SQL Server Insert Snap no longer no longer includes the Preserve case-sensitivity checkbox because the database is case-insensitive. The database stores the data regardless of whether the columns in the target table and the input data are in mixed, lower, or upper case.

November 2022

431patches19268

 

Latest

The SQL Server-Insert Snap now displays the error, Number overflow: <number> (instead of Batch operation failed) when inserting a number into tinyinit column.

November 2022

431patches19234

 

Latest

A memory leak in the SQL Server Stored Procedure Snap is fixed. The Snap now clears the closed connections from memory and retains the open connections.

November 2022

431patches19000

 

Stable/Latest

The SQL Server accounts failed with a certificate error on Windows Snaplexes when using the default SQL driver with the 4.31 main18944 build. This patch addresses the certificate error issue.

November 2022

main18944

 

Stable

The MySQL Insert Snap now creates the target table only from the table metadata of the second input view when the following conditions are met:

  • The Create table if not present checkbox is selected.

  • The target table does not exist.

  • The table metadata is provided in the second input view.

August 2022

430patches17064

 

Latest

The SQL Server - Select Snap now has the Convert rowversion datatype to integer checkbox to support the ROWVERSION data type. Select this checkbox to display the ROWVERSION data type as integers in the output.

4.30 Patch

430patches17368

 

Latest

The SQL Server Execute Snap containing an explicit SQL transaction now works as expected when using a default JDBC driver.

August 2022

main17386

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.29 Patch

429patches16235

 

Latest

Fixed an issue with SQL Server Execute Snap where the Snap did not display a valid error message when the delete condition is invalid.

4.29

main15993

 

Stable

Enhanced the SQL Server - Bulk Load Snap with the Batch Size field to process records in a batch.

4.28 Patch

428patches14649

 

Latest

Enhanced the SQL Server - Select and SQL Server - Lookup Snaps with Option for Unique Identifier Column that allows you to convert the case to lower or upper while displaying the Unique Identifier output (display) value.

4.28

main14627

 

Stable

Updated the label for Delete Condition to Delete Condition (Truncates Table if empty) in the SQL Server Delete Snap.

4.27

main12833

 

Stable

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

4.26 Patch

426patches12535

Latest

Fixed an issue in the SQL Server Bulk Load snap where boolean data type failed to load into BIT field.

4.26

main11181

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.25 Patch

425patches10797

 

Latest

Fixed an issue with the SQL Server - Bulk Load Snap where the Snap fails when the login password contains a colon or a less than (<) symbol.

4.25

main9554

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.24 Patch

424patches8657

 

Latest

Enhances the SQL Server - Select Snap by introducing a new field, Query Hints, which helps to customize and optimize the database engine to process query statements.

4.24

main8556

Stable

  • Enhances the SQL Server - Select Snap to return only the selected output fields or columns in the output schema (second output view) using the Fetch Output Fields In Schema check box. If the Output Fields field is empty all the columns are visible.

  • Enhances the SQL Server - 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.23 Patch

423patches8190

 

Latest

Fixes an issue with SQL Server - Execute to handle SQL statements that begin with special characters.

4.23

main7430

 

Stable

Enhances the accounts in this Snap Pack to allow Windows-based (Active Directory) authentication and user impersonation for SQL Server user accounts.

4.22 Patch

422patches6728

 

Latest

Enhances the SQL Server Snap pack to allow Windows (Active Directory) based authentication and user impersonation for SQL Server user accounts.

4.22

main6403

 

Stable

Upgraded 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 Patch

MULTIPLE8841

 

Latest

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

4.21 Patch 

db/sqlserver8837

 

Latest

Fixed the SQL Server - Stored Procedure Snap to support the UUID datatype.

4.21

snapsmrc542

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.20 Patch 

db/sqlserver8793

 

Latest

Fixed an issue in the SQL Server - Insert Snap due to which the Snap failed to load values of data type INT.

4.20 Patch 

db/sqlserver8796

 

Latest

Fixed the SQL Server - Bulk Load Snap to mask the password in the logged exception messages. 

4.20

snapsmrc535

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.19 Patch 

db/sqlserver8413

 

Latest

Fixed an issue with the SQL Server - 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.19

snaprsmrc528

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.18 Patch

 db/sqlserver7989

 

Latest

Fixed an issue in the SQL Server - Merge Snap wherein identity columns are not handled correctly. Also, added a field, Enable Identity Insert, that enables you to insert values into an identity column.

4.18

snapsmrc523

 

Stable

  • Added support for SQL Server account Active Directory authentication for SQL server for driver JAR version mssql-jdbc-6.2.2-jre8.jar.

  • Reverts a 4.17-patch (db/sqlserver7394) update regarding how BIT and BOOLEAN column data type values are displayed. They now display as true or false (4.17 GA behavior in snapsmrc515) rather than converting to 0 or 1 values (4.17-patch behavior).

4.17 Patch

MULTIPLE7479

 

Latest

Fixed an issue with the SQL Server - Lookup Snap wherein it fails a UUID search.

4.17

ALL7402

 

Latest

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

4.17

snapsmrc515

 

Latest

  • Fixed an issue with the SQL Server 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/sqlserver6981

 

Latest

Fixed an issue of slow performance in SQL Server Snaps while using SQL Server Dynamic account type. 

4.16 Patch 

db/sqlserver6818

 

Latest

Fixed an issue with the Lookup Snap passing data simultaneously to output and error views when some values contained spaces at the end.

4.16

snapsmrc508

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.15 Patch

 db/sqlserver6337

 

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

snapsmrc500

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.14 Patch 

db/sqlserver5912

 

Latest

Fixed an issue to parse the right data type and display it in the input schema for SQL Server Snap..

4.14 Patch 

db/sqlserver5665

 

Latest

Implemented a connection retry logic in the SQL Server account to resolve the connection loss issue in a customer's org.

4.14

snapsmrc490

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.13

snapsmrc486

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.12

snapsmrc480

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.11 Patch 

db/sqlserver4388

 

Latest

Fixed an issue with the Stored Procedure Snap that does not maintain the columns' order on the output as per table's definition.

4.11 Patch

 db/sqlserver4288

 

Latest

 SQL Server Snap Pack - Fixed an issue when inserting a valid NaN value into a column.

4.11

snapsmrc465

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.10 Patch

sqlserver3953

 

Latest

Fixed an issue where the SQL Server Stored Procedure gets hanged when more than one Snap existed in the pipeline each processing greater than 1K documents.

4.10

snapsmrc414

 

Stable

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.

4.9.0 Patch

sqlserver3224

 

Latest

Addressed an issue with SQL Server - Bulk Load execution even with 0 input documents

4.9.0 Patch

sqlserver3076

 

Latest

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

4.9

snapsmrc405

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.8.0 Patch

sqlserver2803

 

Latest

Addressed an issue with slow performance with Bulk Load BCP.

4.8.0 Patch

sqlserver2761

 

Latest

Potential fix for JDBC deadlock issue.

4.8.0 Patch

sqlserver2706

 

Latest

Fixed SQL Server Snap Pack rendering dates that are one hour off from the date returned by database query for non-UTC Snaplexes.

4.8

snapsmrc398

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.7

snapsmrc382

 

Stable

  • Extended support for SQL Server Dynamic accounts.

  • Updated the SQL Server Stored Procedure Snap with the Pass through field. 

4.6

snapsmrc362

 

Stable

  • Resolved an issue in SQL Server Bulk Load Snap that caused BCP program related failures.

  • Enhanced to fully support SQL statements with/without expressions & SQL bind variables.

  • Resolved an issue that caused failures when executing merge statements.

4.5.1

snapsmrc344

 

Latest

Upgraded with the latest SnapLogic Platform release.

4.5

snapsmrc344

 

Stable

  • Resolved an issue in SQL Server Execute Snap that erroneously reported a database/schema mismatch during Snap/pipeline execution.

  • Resolved an issue in SQL Server Lookup Snap that occurred when handling case-insensitive field values.

4.4.1

NA

 

Latest

  • Introduced the SQL Bulk Load in this release.

  • No labels

Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.