SQL Server - Lookup

On this Page

Snap type:



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.

Expected upstream Snaps:  Any Snap which produces documents in the output view, such as CSV Parser, JSON Parser, Structure, Mapper.

Expected downstream Snaps:  Any Snap which receives documents in the input view, such as JSON Formatter, Structure, Mapper. The CSV Formatter will cause an error since the output data is not a flattened Map data.

Expected input:  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.

Expected output:  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.



Support and limitations:

Works in Ultra Pipelines if PassThrough is enabled. The snap must always produce a document for every input in an Ultra task.


This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring SQL Server Accounts for information on setting up this type of account.

InputThis 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
OutputThis 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.
ErrorThis Snap has at most one error view and produces zero or more documents in the view.



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

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.

Default value: 

Table Name

Required. The name of the table to execute insert on.

The values can be passed using the pipeline parameters but not the upstream parameter.


Default value:  [None]

Output fields

Required. Enter or select output field names for SQL SELECT statement. If this property is empty, the Snap selects all fields by executing the statement "SELECT * FROM ..."

Exampleemail, address, first, last


Lookup conditions

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

Default value: [None]


Required. Enter or select the JSON path of the lookup column value. The value will be provided by the input data field.
Example:  $email, $first, $last

Default value[None]

Lookup column name

Required. Enter or select the lookup column name.

Example:  email, first, last

Default value: [None]

Pass-through on no lookup match

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.

Default value:  Not selected

Snap Execution

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.


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:

Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates
4.27main12833 Stable

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

4.26 Patch426patches12535Latest

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

4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10797 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.

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

  • 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 Patch423patches8190 Latest

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


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.

StableUpgraded 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 LatestFixes 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.



StableUpgraded 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

StableUpgraded 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 '?'.
StableUpgraded 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.

  • 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 PatchMULTIPLE7479 Latest

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


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

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

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

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

StableUpgraded with the latest SnapLogic Platform release.


StableUpgraded with the latest SnapLogic Platform release.


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

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




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

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



StableUpgraded with the latest SnapLogic Platform release.


  • Extended support for SQL Server Dynamic accounts.
  • Updated the SQL Server Stored Procedure Snap with the Pass through field. 
  • 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.


LatestUpgraded with the latest SnapLogic Platform release.


  • 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.1NA Latest
  • Introduced the SQL Bulk Load in this release.