Versions Compared


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

On this Page

Table of Contents
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:



This Snap provides functionality to lookup records in the target MySQL table and return 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:

Code Block
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.

  • 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 Task Pipelines with pass-through.
  • Multiexcerpt include macro
    pageMySQL Snap Pack

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


InputThis Snap has exactly one document input view. Each document should have values for one AND clause in the WHERE statement
OutputThis Snap has exactly one document output view. The output document includes the corresponding input data under the "original" key. If there is no results from the query, each output field will have null value.
ErrorThis Snap has at most one document 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 suggestable 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:  [None]

Table name

Required. Enter or select the name of SQL table to execute the lookup query 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.
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.


Required. Enter or select the JSON path of the lookup column value. The value will be provided by the input data field.

Default value

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

Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read

Multiexcerpt include macro
pageAnaplan Read


The following example shows how a MySQL object record can be looked up using the MYSQL Lookup Snap and record the data using the MYSQL Execute Snap. In this pipeline, the MySQL Lookup Snap retrieves data from a table called 'Test1'. 

The MySQL Execute Snap executes a select SQL statement to get the information from table Test1.  

The MySQL Lookup Snap runs the lookup query on, and the lookup conditions specify the column names to be looked up in the look-up table Test1.

Additionally, in the Output fields, select the names of the specific output field name(s) for the output preview to contain only those fields('isactive' 'id')  to be recorded on the target table.

Successful execution of the pipeline displays the below output preview:

Excerpt Include
MySQL Snap Pack
MySQL Snap Pack