You can use this account type to connect SQL Server Snaps with SQL Server database by specifying the Account propertiesas expressions referencing Pipeline parameters. Account details specified in this account (at a Snap level) are referred to as Service Accounts.
Expression-enabled authentication fields, such as Username, Password, and Client Secret, support Secrets Management, a SnapLogic add-on that allows you to store endpoint credentials in a third-party secrets manager, such as AWS Secrets Manager, Azure Key Vault, or HashiCorp Vault. During validation and execution, pipelines obtain the credentials directly from the secrets manager. Learn more: Configure Accounts to use secrets.
Prerequisites
None.
Limitations and Known Issues
None.
Account Settings
Field Name*
Field Type
Description
Label*
Default Value: N/A Example: SQL Server Dynamic Account
String
Specify a unique label for the account.
Account properties*
Use this fieldset to enter in the information to create a connection to the databse.
Hostname*
Default Value: N/A Example: 54.98.196.248
String/Expression
Specify the server's address to which you must connect.
Port number
Default Value: 1433 Example: 3306
Integer/Expression
Specify the port number of the database server to which you must connect.
Remove the port number for Windows-based authentication when connecting to SQL Server account with multiple or named instances. Else, SnapLogic tries to connect to the specified port without checking with the Server Browser service list.
Database name*
Default Value: N/A Example: ReportServer
String/Expression
Specify the name of the database to which you must connect.
Username
Default Value: N/A Example: snaplogic
String/Expression
Specify the username 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/Expression
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.
JDBC JARs
Use this fieldset to specify the list of JDBC drivers to connect to the SQL Database.
The default driver bundled with the SQL Server Snap Pack is mssql-jdbc-12.2.0.jre11.jar
Specify the JDBC driver to use. Do not use the same name if you provide multiple drivers. If this property is left blank, a default JDBC driver is loaded.
SQL Server Snap Pack does not support jTDS driver.
Ensure that the JDBC Driver is available in a project directory that you can access. The JDBC Driver Class should default to com.microsoft.sqlserver.jdbc.SQLServerDriver.
Use this fieldset to specify the advanced properties for connecting to the database.
Auto commit
Default value:Selected
Checkbox/Expression
Select this check box 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.
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.
Batch size*
Default value: 50 Example: 60
Integer/Expression
Specify the number of statements to execute at a time. Enter the number of statements to be executed within a batch operation.
SELECT queries are not batched.
When using million rows of data, the bulk copy program (bcp) utility (at the backend) is likely to fail due to lack of space in the database's transaction log. In such cases, use Batch size for better utilization of database resources. However, if you specify a Batch size, the Snap's performance is degraded. Hence, we recommend you to provide Batch size only if your environment is less resource-intensive.
Using a large batch size could use up the JDBC placeholder limit of 2100.
Fetch size*
Default value: 100 Example: 80
Integer/Expression
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/Expression
Specify the maximum number of connections a pool will maintain at a time.
Max lifetime (minutes)*
Default value: 30 Example: 50
Integer/Expression
Specify the maximum lifetime of a connection in the pool, in seconds. 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 (minutes)*
Default value: 5 Example: 8
Integer/Expression
Specify 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.
Checkout timeout (milliseconds)*
Default value: 10000 Example: 100
Integer/Expression
Specify the number of 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: selectMethod Example: selectMethod
String/Expression
Specify a name for the URL property if any.
URL property value
Default Value: cursor Example: cursor
String/Expression
Specify a value for the URL property name.
SQL Server Authentication
In the Account Settings, provide the Username and Password as defined for the user on the SQL Server instance. See the Create Account screen for reference. This SQL Server account must have the required privileges to run seamlessly, the operations defined for the Snaps in this Snap Pack.
DO NOT use the default sa account for SQL Server Authentication. See SQL Docs: Security: Authentication mode to learn how to choose between SQL Server Authentication and Windows Authentication.
java.lang.UnsatisfiedLinkError: Native Library C:\\opt\\snaplogic\\ldlib\\sqljdbc_auth.dll already loaded in another classloader.
You have uploaded customized JDBC JAR files to the directory.
Remove all JDBC JARs from the SQL Server account and restart the JCC node.
com.microsoft.sqlserver.jdbc.SQLServerException: This driver is not configured for integrated authentication.
The correct sqljdbc_auth.dll file is not available in the ldlib folder.
Download the appropriate sqljdbc_auth.dll file and place it in $SL_ROOT/ldlib.
No valid credentials provided OR Server not found in Kerberos database.
The Service Principal Name (SPN) is not setup properly.
Ensure that you have setup the SPN for MSSQLSvc service properly.
Defective token detected
Kerberos fails when a mismatch occurs between the SPN for the SQL Server service and the hostName.
For example, if FQDN of the machine is used to setup SPN, the hostName must be an FQDN and not an IP address, while establishing a connection.
Provide a value for hostName that matches with the SPN in context. Also ensure that the properties authenticationScheme, domain and integratedSecurity are defined for the account.
Snap Pack History
Click here to expand...
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 - DeleteSnap 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.
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 checkboxbecause 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.
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-historizationfields 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 testperiod 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.
