MySQL - Multi Execute

On this Page

Snap type:

Write


Description:

This Snap allows you to execute multiple SQL statements for each document. Each set of statements is executed as one transaction (per document).
The Snap will substitute values from an incoming document into the SQL statement if it finds a JSONPath substring in the statement. If a substitution value is missing in the incoming document then the document will be written to an error view.

Multiple documents can not be executed as part of one transaction, the relationship is one transaction per document.

This Snap only supports write operations.

The account being used must have auto commit set to false, otherwise the Snap will fail with a configuration exception.

You can drop your database with it, so be careful.


  • Expected upstream Snaps: A Mapper Snap, which transforms the input data into the exact structure that is needed by each statement of the Snap.
  • Expected downstream Snaps: The Snap will output one document for every document retrieved, hence any document processing Snap can be used down stream. Each output document will provide information about the statements that were executed. 
  • Expected input: Document that conforms to variables needed for each statement.
  • Expected output: Document which provides information about the status of the execution, each statement is represented as an execution_<index>, where <index> is the row number in the Executions table. For convenience, each execution_<index> will provide the statement that was executed and the input data that was used to execute the statement.


Prerequisites:

[None]


Support and limitations:

Works in Ultra Task Pipelines if Batch Size is not selected.

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.
OutputThis Snap has at most one document output view.
Error

This Snap has at most one document error view and produces zero or more documents in the view.

Database write Snaps output all records of a batch (as configured in your account settings) to the error view if the write fails during batch processing.

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.

Executions



Required. A list of statements that are executed as one transaction.


Path

A JSONPath that returns a list or object from the input document.

ExamplejsonPath($, "$ADJUSTMENTS[*]")


SQL Statement

A SQL statement that uses the result of the path as part of the statement substitution.

Examples:

  • Insert into ADJUSTMENTS VALUES ($BUS_AREA_CD, $CR_FG, $FUNC_AREA_CD, $LGCL_DEL_FG, $MAIN_MCC_FG, $PR_EFF_DT, $SO_ADJ_AM, $SO_ADJ_CD)

Without using expressions

  • email = 'you@example.com' or email = $email 
  • emp=$emp

Using expressions

  • "EMPNO=$EMPNO and ENAME=$EMPNAME"
  • "emp='" + $emp + "'"
  • "EMPNO=" + $EMPNO + " and ENAME='" + $EMPNAME+ "'"

Caution

Using expressions that join strings together to create SQL queries or conditions has a potential SQL injection risk and hence unsafe. Ensure that you understand all implications and risks involved before using concatenation of strings with '=' Expression enabled. 

Single quotes in values must be escaped

Any relational database (RDBMS) treats single quotes (') as special symbols. So, single quotes in the data or values passed through a DML query may cause the Snap to fail when the query is executed using MySQL. Ensure that you pass two consecutive single quotes ('') or a single quote preceded by a backslash (\') in place of each single quote within these values to escape it through these queries.

For example:

If String To pass this valueUse
Has no single quotes
Schaum Series
'Schaum Series'
Contains single quotes
O'Reilly's Publication
'O''Reilly''s Publication' OR
'O\'Reilly\'s Publication'
Number of retries

Specifies the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response.

Example: 3

Default value: 0

Retry interval (seconds)

Specifies the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. 

Example:  10

Default value: 1

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.

Examples


Update the order details and adjustments information into a Orders database (MySQL instance) in a single go

This example demonstrates how you can use the MySQL - Multi Execute Snap to execute multiple SQL queries on a MySQL database instance. The Pipeline contains order details and adjustments information (in the JSON Generator Snap) to be inserted and the SQL queries to be executed (in MySQL - Multi Execute Snap) for inserting this data into the corresponding tables in the MySQL database instance.

Download this Pipeline.

The Pipeline performs the following steps in that sequence.

  • Prepare input values using JSON Generator.
  • Define the table mappings using a Mapper.
  • Pass the values using these mappings to the multiple MySQL queries.

Example DDL file: Run the CREATE queries in this DDL file to create the required tables for running the sample SQL queries in MySQL Database.

Prepare input values using JSON Generator

JSON Generator

InputOutput

Define the table mappings using a Mapper

Mapper

Output

Pass the values using these mappings to the multiple MySQL queries

MySQL - Multi Execute

In path one, we select $adjustments; given the input, it returns a list of objects. The SQL statement can use variables that are the result of the path execution.

For example, jsonPath($, "$ADJUSTMENTS[*]) results in the following input for the SQL statement.

 {
    "SO_ADJ_CD": "ZNAJ",
    "SO_ADJ_AM": "0.00",
    "LGCL_DEL_FG": "N",
    "CR_FG": "N",
    "MAIN_MCC_FG": "",
    "BUS_AREA_CD": "9600",
    "FUNC_AREA_CD": "A051",
    "PR_EFF_DT": ""
 },
 {
    "SO_ADJ_CD": "ZNAK",
    "SO_ADJ_AM": "0.00",
    "LGCL_DEL_FG": "N",
    "CR_FG": "N",
    "MAIN_MCC_FG": "",
    "BUS_AREA_CD": "9600",
    "FUNC_AREA_CD": "A051",
    "PR_EFF_DT": ""
 }
  • The INSERT statement creates a batch for every object in the list and execute it. 

In path two, we select the $order_detail; given the input, it returns one object.

  • The INSERT statement executes one statement using the $order_detail object.

The statement, then, refers to the variables of the result using for example, $BUS_AREA_CD, not as the whole path to the variable in context of the input document: jsonPath($, "$ADJUSTMENTS[*].BUS_AREA_CD), instead the context is the result of the path evaluation.

  • A successful execution of all statements logs the transaction as successful.
  • Any failure of any of the statements causes a rollback of all issued operations for the given input document.
Output (Successful Execution)

One output document is written per input document. The output document provides executions, each reflecting the execution of one row. 

  • The index of the execution_<index> represents the index of the statement in the Executions table.
  • Each execution provides information about the statement execution.
    • When all statements are executed successfully, original key shows the data that was used as part of the statement execution (not the input document, but the data of the path evaluation).
    • SqlStatement shows the statement that was executed.

Error details for troubleshooting SQL query executions

To gain a better understanding of the root cause in case of an unsuccessful query execution, enable the error view. The output displays the execution details with respective status (success / failure) of each execution. 

In the example error output below, execution_1 of the current input document failed. The reason and resolution are provided, along with the stacktrace for debugging purpose.

[
  {
    "execution_1": {
      "status": "failed",
      "sqlStatement": "Insert into wrongname VALUES (?, ?, ?, ?, ?)",
      "errorDocuments": [
        {
          "error": "Failed to flush batch.",
          "reason": "Table 'integration.wrongname' doesn't exist",
          "original": {
            "SO_LN_ITM_NR": "000010",
            "SO_DTL_CRT_DT": "2014-02-12",
            "SO_DTL_CLOSE_DT": "2014-02-12",
            "FXD_VALU_DT": "2014-02-12",
            "ORD_LN_CNCL_DT": ""
          },
          "resolution": "Please address the issue reported by the database.",
          "stacktrace": "org.jooq.exception.DataAccessException: 
          SQL [Insert into wrongname VALUES (?, ?, ?, ?, ?)]; 
          Table 'integration.wrongname' doesn't exist\n...."
        }
      ]
    },
    "execution_0": {
      "status": "success",
      "sqlStatement": "Insert into ADJUSTMENTS VALUES (?, ?, ?, ?, ?, ?, ?, ?)",
      "successfulDocuments": [
        {
          "message": "success",
          "status": 2,
          "original": {
            "SO_ADJ_CD": "ZNAJ",
            "SO_ADJ_AM": "0.00",
            "LGCL_DEL_FG": "N",
            "CR_FG": "N",
            "MAIN_MCC_FG": "",
            "BUS_AREA_CD": "9600",
            "FUNC_AREA_CD": "A051",
            "PR_EFF_DT": ""
          }
        },
        {
          "message": "success",
          "status": 2,
          "original": {
            "SO_ADJ_CD": "ZNAK",
            "SO_ADJ_AM": "0.00",
            "LGCL_DEL_FG": "N",
            "CR_FG": "N",
            "MAIN_MCC_FG": "",
            "BUS_AREA_CD": "9600",
            "FUNC_AREA_CD": "A051",
            "PR_EFF_DT": ""
          }
        }
      ]
    }
  }
]

Execute multiple SQL statements to insert, update and delete records from MySQL DB

This pipeline shows how to execute the multiple MySQL statements to insert records into the table, TAM_SAMPLE_PERSONS, using the MySQL Multi Execute Snap. We pass the values into the records via the upstream Mapper Snap. 


The Mapper Snap maps the values to be updated into the table, TAM_SAMPLE_PERSONS .

In the MySQL Multi Execute Snap, the MySQL statement executions are as below:

Note that the Multi Execute Snap performs the Insert, Update and the Delete functions.

The successful execution of the pipeline displays the below output preview:


Downloads

  File Modified

File MySQL_MultiExecute_Example_Pipeline_1.slp

Jul 31, 2020 by Anand Vedam

ZIP Archive example_ddl.zip

Jul 31, 2020 by Anand Vedam

Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates
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.