In this article
Overview
You can use this Snap provides functionality to lookup records in the target SQL Server table and returns a selected set of fields for every matched record. The Snap executes one request per multiple input documents to avoid making a request for every input record.
JSON paths can be used in the Snap properties and will have values from an incoming document substituted into the properties. However, documents missing values for a given JSON path will be written to the Snap's error view. After a query is executed, the query's results are merged into the incoming document.
Queries produced by the Snap have the format:
SELECT [Output fields] FROM [Table name] WHERE [C1 = V11 AND C2 = V21 AND...[Cn = Vn1] OR [C1 = V12 AND C2 = V22 AND...[Cn = Vn2] OR ...................................... OR [Cn = V1n AND Cm = V2m AND...[Cn = Vnm]
The Snap ignores any duplicated lookup condition in the input document stream since it maintains a cache for lookup conditions internally. This Snap supports SQL Server 2008 or newer.
Snap Type
SQL Server - Lookup Snap is a Read-type Snap that provides functionality to lookup records in the target SQL Server table and return a selected set of fields for every matched record.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines if PassThrough is enabled. The snap must always produce a document for every input in an Ultra task.
Known Issues & Limitations
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input | Document |
|
| This Snap allows exactly one input view and expects documents in the view. Each document should have values for one AND clause in the WHERE statement. Each document in the input view should contain a Map data of key-value entries. Input data may contain values needed to evaluate expressions in the Object type, Output fields, and Conditions properties. If the Pass-though on no lookup match property is unchecked, please make sure input data types match column data types in the database table. Otherwise, you may encounter an error message "Cannot find an input data which is related to the output record .....". If the error view is open, all input data in the batch are routed to the error view with the same error information. |
Output | Document |
|
| This Snap has exactly one output view and produces documents in the view. The output document includes the corresponding input data under the "original" key. If there are no results from the query, each output field will have a null value. Each document in the output view contains a Map data of key-value entries, where keys are the Output fields property values. The input data that has produced the corresponding output data is also included in the output data under the "original" key. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. | |||
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (
): Indicates a list that is dynamically populated based on the configuration.Expression icon (
): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.Add icon (
): Indicates that you can add fields in the field set.Remove icon (
): Indicates that you can remove fields from the field set.
Field Name | Field Type | Description | |
Label* Default Value: SQL Server - Lookup | String | Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | |
|---|---|---|---|
Schema name Default Value: N/A | String/Expression | Specify the database schema name. In case it is not defined, then the suggestion for the Table Name will retrieve all tables names of all schemas. The property is suggestible and will retrieve available database schemas during suggest values. The values can be passed using the pipeline parameters but not the upstream parameter. | |
Table name*
Default Value: N/A | String/Expression | Specify the name of the table to execute insert on. The values can be passed using the pipeline parameters but not the upstream parameter. | |
Output fields | Use this fieldset to enter output fields for SQL SELECT statement. | ||
Output fields Default Value: N/A | String/Expression | Specify the output field names for SQL SELECT statement. If this property is empty, the Snap selects all fields by executing the statement "SELECT * FROM ..." | |
Lookup conditions* | Use this fieldset to enter or select the lookup column name. The lookup conditions are created by using the lookup column name and the lookup column value. Each row will build a condition, such as lookupColumn1 = $inputField. Each additional row will be concatenated using a logical AND. All rows together build the lookup condition being used to lookup records in the lookup table. | ||
Value* Default Value: N/A | String/Expression | Specify the JSON path of the lookup column value. The value will be provided by the input data field. | |
Lookup column name* Default Value: N/A | String/Expression | Specify the lookup column name. | |
Pass-through on no lookup match Default Value: Deselected | Checkbox | Select when there is no lookup matching an input document, the input document will pass through to the output view if this property is checked. Otherwise, it will be written to the error view as an error condition. | |
Number of Retries Default Value: 0 | Integer/Expression | Specify the maximum number of retry attempts when the Snap fails to read. Minimum value: 0 | |
Retry Interval (seconds) Default value: 1 | Integer/Expression | Specify the minimum number of seconds the Snap must wait before each retry attempt. Minimum value: 1 | |
Option for Unique Identifier Column Default Value: Convert to lower case | Dropdown list | Conditional. This property applies only when the Snap returns the unique identifier (GUID) in the output. Specify the unique identifier is stored in the database using an internal format and when it is displayed in the output, it is converted to a string and gets displayed in upper case for HEX characters. Select either of the following options to change the case type. Available options are:
| |
Page lookup error: page "Anaplan Read" not found. If you're experiencing issues please see our Troubleshooting Guide. Default Value: Validate & Execute | Dropdown list | Page lookup error: page "Anaplan Read" not found. If you're experiencing issues please see our Troubleshooting Guide. | |
Examples
In this example, we will show how the Lookup Snap retrieves data from a table called 'customer1'.
We can pass the dynamic variable used in the where clause from an upstream Snap like JSON Generator. We try to retrieve customers with the condition applied on 'customername' field. In this example, only two fields ('customername', 'product') are shown in the output fields set in the Output fields property.
The sample output looks like:
Release Snap Pack Version Date Type Updates May 2025 441patches31537 Latest Fixed a null pointer exception issue in the SQL Server Execute Snap when the key or value in the URL properties field in the SQL Server Account or SQL Server Dynamic Account was left blank. May 2025 main31019 Stable Updated and certified against the current SnapLogic Platform release. February 2025 440patches30071 Latest Fixed the Null Pointer Exception (NPE) issue in the SQL Server Snaps. Now, these Snaps display an exception error instead of NPE when the URL properties (key and value) and either key or value are empty. February 2025 440patches29922 Latest Fixed an issue with the SQL server Select, Execute, and Insert Snaps that failed with ClassCastException for geometry and geography data types when using custom jar files. February 2025 main29887 Stable Updated and certified against the current SnapLogic Platform release. 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 May 2024 437patches27091 Latest Fixed a case-sensitivity issue with the SQL Server—Bulk Load Snap that caused a 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 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 Behavior change: February 2024 main25112 Stable As of 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: Pipelines NOT using the default driver (bundled with the SQL Server Snap Pack) will not fail. 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: Pipelines NOT using the default driver (bundled with the SQL Server Snap Pack) will not fail. The Microsoft JDBC Driver 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, 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 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 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 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. February 2025 February 2025 Latest Latestdecimal-type column.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.TinyInt datatype. The Snap now correctly inserts 1 or 0 for true or false in the table, respectively. integer-type column.
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.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.trustServerCertificate = true
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 trustServerCertificate = true12.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.Number overflow: <number> (instead of Batch operation failed) when inserting a number into tinyinit column.4.31 main18944 build. This patch addresses the certificate error issue.ROWVERSION data type. Select this checkbox to display the ROWVERSION data type as integers in the output.mssql-jdbc-6.2.2-jre8.jar.