MySQL - Lookup

On this Page

Snap type:

Read


Description:

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:

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.


Prerequisites:

[None]


Support and limitations:
  • Works in Ultra Tasks with pass-through.
  • When MySQL execute Snaps (MySQL - Execute and MySQL - Multi Execute) are followed by MySQL non-execute Snaps, such as MySQL - Insert, MySQL - Merge, and so on, the following error is displayed when executed:

    Table definition has changed, please retry transaction.

    This happens due to a known issue in the MySql Connector. For more information about this issue, see MySQL Bug #65378.

Account: 

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.


Views:
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.

Settings

Label


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.

Example: SYS
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.


Example: people
Default value:  [None]
 

Output fields

Required. Enter or select output field names for SQL SELECT statement.
Example: email, address, first, last
Default: [None]
 

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.


Value


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

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


Snap Execution

Select one of the following three modes in which the Snap executes:

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

Default Value: Execute only
Example: Validate & Execute


Example



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:


Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates
November 2024main29029 StableUpdated and certified against the current SnapLogic Platform release.

August 2024

main27765

 

Stable

Updated and certified against the current Snaplogic Platform release.

May 2024437patches26298 Latest

Fixed an issue with the MySQL - Multi Execute Snap and the MySQL - Execute Snaps that displayed a null pointer exception when the Snap did not check  null table metadata.

May 2024main26341 StableUpdated the Delete Condition (Truncates a Table if empty) field in the MySQL - 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 2024436patches25659 Latest
  • Fixed an issue with the MySQL- Multi Execute Snap that committed the changes when the Snap was expected to roll back if any query failed and the Number of Retries was more than 0. The Snap now performs a rollback when one or more queries fail.

  • Fixed an issue with the MySQL-Insert Snap that displayed an error when you inserted values such as 128 or more in the Tinyint unsigned datatype when the datatype must accept all the values in the range of 0-255.

  • Fixed an issue with MySQL-Insert Snap that failed to store the Time datatype with precision in the target table when passed from an upstream Mapper Snap in the string format or Date-only date format.

February 2024main25112 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main23721

 

StableUpdated and certified against the current SnapLogic Platform release.

August 2023

main22460

 


Stable

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

May 2023

main21015 

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023432patches19870 Latest

Fixed an issue with the preview data of the MySQL-Execute Snap that displayed the date format as %m %d %Y (without the forward slash '/'). The Snap now displays the date as intended in %m/%d/%Y format after validation.

February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
November 2022431patches19263 Latest

The MySQL Insert Snap 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 2022main18944 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.

September 2022430patches17894 Latest

The MySQL Select Snap now work as expected when the table name is dependent on an upstream input;

August 2022430patches17387 Latest

The following issues are fixed in the MySQL Bulk Load Snap:

  • Writing the first batch of records to a temporary file after the Snap fails. Now the Snap writes to the error view as is the expected behavior.

  • Temporary files generation when a record does not contain a table column. Now, the Snaplex removes the temporary files created along with the directory after the Pipeline execution.

August 2022main17386 StableUpgraded with the latest SnapLogic Platform release.

4.29

main15993

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.28 Patch

428patches15101

 Latest

Fixed an issue with SQL Server - Execute Snap where the Pipeline was failing when there were consecutive execute Snaps with a procedure call, followed by select statements.

4.28main14627 StableUpdated the label for Delete Condition to Delete Condition (Truncates Table if empty) in the MySQL Delete Snap.
4.27main12833 Stable
  • Enhanced the MySQL Database Account to skip batch execution, when the Batch size value is one. When the Batch size is greater than one, the batch is executed.
  • Enhanced the MySQL - Execute Snap to invoke stored procedures.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25425patches11008 Latest
  • Enhanced the MySQL - Lookup Snap suggestions to load the Output Fields and Lookup Column settings.
  • Fixed an issue with MySQL - Select Snap where the second output view of the Snap was showing empty column values and improved the error messages in the Snap where the Snap fails with Null Pointer Exception when the account reference provided is invalid.
4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
Stable
  • Enhances the MySQL - Select Snap to return only the fields (provided in the Output Fields) in the output schema (second output view), through a new check box Fetch Output Fields In Schema. If the Output Fields property is empty all the columns are visible.
  • Enhances the MySQL - 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 Patch423patches7732 Latest

Fixes an issue in the MySQL - Bulk Load Snap to support the following versions:

  • MySQL 8.0.17 
  • MySQL 5.6.34
4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22 Patch422patches6629 Latest

Fixes the MySQL Snap Pack by acknowledging the lineage information of the original document in an empty output view when Pass Through is enabled. 

4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21 Patch421patches6272 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 Patch421patches6144 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
mysql8842 Latest
  • Fixes the SSH tunneling issue by ensuring connectivity between JCC and MySQL server.

  • Updates the UI for MySQL Accounts to simplify the SSH tunneling configuration as described in Configuring MySQL Accounts.

4.21 PatchMULTIPLE8841 Latest

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

4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.

4.20 Patch 

db/mysql8815 Latest

Fixes the MySQL Stored Procedure Snap to resolve compatibility issues with the Amazon Aurora database.

4.20 Patch 

db/mysql8786 Latest

Fixes the MySQL - Bulk Load Snap to use the UTF-8 character set for writing temporary files in order to successfully handle special characters, irrespective of the value specified in the Character set field in the Snap settings.  

4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19 Patch db/mysql8638 Latest

Fixes the MySQL Database Account where the associated Snaps produce a huge count of open file descriptors when the Configure SSH Tunnel property is enabled.

4.19 Patch 

db/mysql8635 Latest

Fixes the MySQL - Execute Snap where the retry option fails to establish a connection with the MySQL database, after an interrupted transmission.

4.19 Patch 

db/mysql8407 Latest

Fixes an issue with the MySQL - 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 Patch 

db/mysql8390 Latest

Fixes an issue wherein the MySQL Snaps are unable to reconnect to the MySQL database after the breakdown of a connection.

4.19 Patch 

db/mysql8340 Latest

Fixes an issue with the MySQL Bulk Load Snap wherein the Snap is unable to execute the bulk load feature with MySQL 8.0 and higher versions.

4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18 Patch db/mysql7846 Latest

Fixed an issue with the MySQL Snaps wherein the Snaps exhibit degraded performance with snapsmrc523.

4.18snapsmrc523
 
Stable

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

4.17 Patch db/mysql7395 Latest

Fixed an issue wherein bit data types in the MySQL - Select table convert to true or false instead of 0 or 1.

4.17 Patch db/mysql7357 Latest

Fixed an issue with the MySQL Execute snap wherein the Retry property for connection fails after the database connection is severed.

4.17ALL7402
 
Latest

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

4.17snapsmrc515
 
Latest
  • Fixed an issue with the MySQL 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 PatchMULTIPLE7123 Latest

Added two new properties, Number of retries and Retry interval, to Delete, Insert, Select, Execute, Merge, Update, and MutliExecute Snaps that enables you to handle retry attempts during a connection failure.

4.16 Patch db/mysql6823 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.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15 PatchMULTIPLE6413 Latest

Added 2 new properties, JDBC Driver Class and JDBC JARs. The new properties enable uploading JDBC JARs that help connect to MYSQL8.

4.15 Patch db/mysql6332 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.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12 Patch db/mysql4924 Latest

Fixed the MySQL Bulk Load Snap so that it doesn't produce an output document if there are no input documents.

4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11snapsmrc465
 
Stable
  • New! MySQL Stored Procedure Snap added to call/execute MySQL Stored Procedure.
  • SSH Tunnelling related properties added at the Account level for both MySQL Dynamic Account and MySQL Database Account.
4.10 Patchmysql3988 Latest

SSH Tunnelling related properties added at the Account level for both MySQL Dynamic Account and MySQL Database Account.

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

mysql3070 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.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.
4.8.0 Patchmysql2755 Latest

Potential fix for JDBC deadlock issue.

4.8.0 Patch

mysql2695 Latest

Addresses an issue where some changes made in the platform patch MRC294 to improve perfomance caused Snaps in the listed Snap Packs to fail. 

4.8

snapsmrc398

 
Stable
  • Info tab added to accounts.
  • Database accounts now invalidate connection pools if account properties are modified and login attempts fail.

4.7.0 Patch

mysql2189 Latest

Fixed an issue for database Select Snaps regarding Limit rows not supporting an empty string from a pipeline parameter.

4.7.0 Patch

mysql2280

 Latest

MySQL Merge will now route documents to the output and error views correctly

4.7

snapsmrc382

 
Stable

Added a new Snap, MySQL Bulk Load.

4.6snapsmrc362
 
Stable
  • Enhanced MySQL Execute Snap to fully support SQL statements with/without expressions & SQL bind variables.
  • Extended support for MySQL Dynamic accounts.
  • Resolved an issue in MySQL Select Snap that caused failures in the second output view when retrieving outputs from a table with a dot (.) character.
  • Resolved an issue in MySQL Execute Snap that caused failures when passing expression ($variable_name) for stored procedures.
  • Resolved an issue in MySQL Execute Snap that caused failures when an SQL statement had an inline comment.
  • Resolved an issue in MySQL Execute Snap that ignored all statements after "–".
4.5.1

snapsmrc344

 
Stable

Fixed an error in a tooltip for MySQL - Select Snap.

4.5

snapsmrc344

 Latest

Resolved an issue in MySQL Insert Snap to ensure an error is reported when table column is set to NOT NULL.

4.4.1NA StableUpgraded with the latest SnapLogic Platform release.
4.4NA StableUpgraded with the latest SnapLogic Platform release.
4.3.2NA Stable
  • NEW! MySQL Lookup Snap
  • Improved performance of the MySQL Execute Snap.
4.3NANAStable

Table List Snap: A new option, Compute table graph, now lets you determine whether or not to generate dependents data into the output.

4.2.2

NANAStable
  • Ignore empty result added to Execute and Select Snaps. The option will not write any document to the output view for select statements producing no results.
  • Resolved a Java exception in MySQL Merge Snap.