MySQL - Stored Procedure

On this Page

Snap Type:Write
Description:

This Snap executes a stored procedure in a MySQL database and writes the values of OUT and INOUT parameters to the output views.

ETL Transformations & Data Flow

The Snap invokes the Stored procedure, and the ETL operations are carried out as specified on the stored procedure.

Ideally, there is no data flow from the Snap to the database, however, the results computed in the store procedure or the result of queries executed in the stored procedure can be fetched by the Snap through output parameters.

Input & Output

  • Input:  This Snap can have an upstream Snap that can pass a document to the output view (for example, Structure or JSON Generator). The input document may contain values for the Snap expression properties, typically for the Parameter values property.

    Example:     "John" and "Smith" are values for the stored procedure's input parameters, the first and the second, respectively.


{
firstName: "John". lastName: "Smith" 
  • Output:   Output document in the output view contains a key-value pair for each output parameter. It will be an empty map document if there is no output parameter. Output document in the Result Set output view contains the result set of the stored procedure.

  • Expected upstream Snaps:  Any Snap with document output view

    Expected downstream Snaps:  Any Snap with document input view

Modes

Prerequisites:None at the moment.
Limitation and Known Issues

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.

Views:
InputThis Snap has exactly one document input view.
OutputThis Snap has exactly two document output views, one regular output view, and one Result Set output view.
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 schema name where the procedure resides. The property is suggestible and will return all schemas of the DB.

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

Example: dbo

Default value: [None] 

Stored procedure name

Required. Stored procedure to execute. The property is suggestible and will return all procedures of the DB. If a schema is defined then it will return all procedures of that schema.

Example: addSeventeen

Default value: [None] 

Parameter values

Select the input parameter values for the stored procedure. 
If you define parameter values, you must do so in the same order as they appear in the stored procedure definition to ensure that the data type of the values you enter matches the data type of their corresponding parameters. If the values do not match the defined data type for the parameter an exception is thrown and the Snap does not execute.

Example: Suppose there is a stored procedure named createGreeting.  It has three parameters p1,p2, p3 and p4.  p1 and p2 are input parameters of type VARCHAR2, p3 is INOUT parameter of type VARCHAR2, then three string values provided.  The first value goes to p1, the second to p2, and the third to p3.

Quotation marks should not be used when setting input parameters unless they are part of the input value itself, since they are treated as escaped plain characters. For example, if the desired input value is TEST_VALUE1, the input parameter should be set as TEST_VALUE1, if you set it as "TEST_VALUE1", it will be recognized as \"TEST_VALUE1\".

Default value: [None]

If you do not provide any parameters in the Snap, you can still view the required input parameters in the Target Schema of the upstream Mapper Snap. The parameters are dynamically populated based on the column keys of the stored procedure; you can map the parameters and pass them as an input to the Stored Procedure Snap.

Pass through

If selected, the input document will be passed through to the output views under the key 'original'. The document will be passed to the Parameter output view, and it will also be passed to the Result Set output view if there is output sent from this view.

This property applies only to the Execute Snaps with SELECT statement or the Select Snaps. 

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.


Examples

Basic Use Case 1


The following pipeline describes how the Snap functions as a standalone Snap in a pipeline:



In this pipeline the stored procedure 'date rs2 demo' from the 'enron' schema is invoked using the MySQL Stored Procedure Snap. The stored procedure is as below:

CREATE DEFINER=`mysqlqatest`@`%` PROCEDURE `date_rs2_demo`(IN inparam INT, OUT dc date, OUT dtc datetime, OUT tsc timestamp)
      BEGIN
           select dateC INTO dc from DateTypesDemo limit 1;
           select datetimeC INTO dtc from DateTypesDemo limit 1;
           select timestampC INTO tsc from DateTypesDemo limit 1;
           select * from DateTypesDemo;
           select * from AVemployees;	
      END


The value for the IN parameter is passed in the Parameter values property in the Snap: 

The output from the Snap are the OUT parameters and their values, and the result set from  the output parameters as seen in the images below:



Basic Use Case 2


In this example, the parameter values are passed to the MySQL Stored Procedure Snap through a Mapper Snap. 


In this case, the MySQL Stored Procedure Snap will invoke the following stored procedure:


DELIMITER $$

USE `enron`$$

DROP PROCEDURE IF EXISTS `basicDataTypes`$$

CREATE DEFINER=`mysqlqatest`@`%` PROCEDURE `basicDataTypes`(IN inParamInt INT, IN inParamVarchar VARCHAR(32), IN inParamBit BIT, OUT outParamInt INT, OUT outParamVarchar VARCHAR(32), OUT outParamBit BIT)
       BEGIN
            SET outParamInt= inParamInt;
            SET outParamVarchar= inParamVarchar;
            SET outParamBit= inParamBit;
       END$$

DELIMITER ;

In this stored procedure there is no result set; therefore, none will be generated when the pipeline is executed.

The Mapper Snap is used to pass the IN parameter's value to $id, the output preview can also be seen in the Output preview data section: 

The MySQL Stored Procedure Snap is configured as shown below. One of the IN parameters is passed as an expression. This is is the data received from the Mapper Snap:

As mentioned earlier, there will be no output result set because there is no result set from the stored procedure. The Result Set Ouput View will have no outputs and just the output parameters and their corresponding values will be shown by the Snap (in the Output Parameter output view). See the image below:


Typical Snap Configurations


The key configuration lies in how the SQL statement is passed. In this Snap it is possible to pass the values in the following ways:

  • Without Expression
    The values can be passed directly in the Snap: 

    With Expression
    • Using Pipeline Parameters:
      The Parameter value is passed as a pipeline parameter.


        

Advanced Use Case

The following pipeline is an example of how the MySQL Stored Procedure Snap is used in a scenario where data from a MySQL instance is inserted in a SQL instance. The pipeline can be downloaded from the Downloads section below:

In this pipeline there are two stored procedures that will be invoked - "enron.SP_Emp_Delete" and "enron.Multiple_Statements".

The first stored procedure is as shown below:

CREATE PROCEDURE enron.SP_Emp_Delete(IN empno1 INT,IN empno2 INT)
      BEGIN
           DELETE FROM sp_emp WHERE empid=empno1;
           DELETE FROM sp_emp WHERE empid=empno2;
      END

There are no OUT parameters in this stored procedure. No outputs will be shown in the Output Parameter output view.

The second stored procedure is as shown below:

CREATE PROCEDURE enron.Multiple_Statements(IN empno1 INT,empno2 INT, OUT result1  INT,OUT result2 INT)
      BEGIN
           INSERT INTO sp_emp (empid,ename) VALUES (empno1,'snaplogic1');
           INSERT INTO sp_emp (empid,ename) VALUES (empno2,'snaplogic12');
           SELECT empid INTO result1 FROM sp_emp WHERE ename='snaplogic1';
           SELECT empid INTO result2 FROM sp_emp WHERE ename='snaplogic2';
      END

This pipeline does the following ETL operations:

  • Load: The first Mapper Snap maps the values "501", and "502" to the fields "empno1" and "empno2" in the target schema.
  • Transform: The first MySQL Stored Procedure Snap invokes the stored procedure "enron.SP_Emp_Delete" that deletes the records in the table that match the values in the "empno1" and "empno2" fields.
  • Load: The second Mapper Snap maps the values "501", "502", "snaplogic1", and "snaplogic12" to the "empno1", "empno2", "ename1", and "ename2" fields in the target schema.
  • Load: The second MySQL Stored Procedure Snap invokes the stored procedure "enron.Multiple_Statements" that inserts the records into the target table.
  • Extract & Load: The stored procedure "enron.Multiple_Statements" invoked by the second MySQL Stored Procedure Snap also extracts records from the table and writes the "empid" into the "result1" and "result2" fields where there is a matching record based on the "ename" field.
  • Load: The data passed from the second MySQL Stored Procedure Snap is inserted into the specified SQL database by the SQL Server Insert Snap.
  • Extract: The records in the specified SQL table are retrieved by the SQL Server Select Snap, demonstrating that the pipeline was executed successfully.


 The e
xported pipeline is available for download in the Download section.



Downloads

Important steps to successfully reuse Pipelines

  1. Download and import the pipeline into the SnapLogic application.
  2. Configure Snap accounts as applicable.
  3. Provide pipeline parameters as applicable.

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.