This Snap allows you to execute arbitrary SQL. This Snap works only with single queries.
You can drop your database with it, so be careful.
Valid JSON paths that are defined in the where clause for queries/statements will be substituted with values from an incoming document. Documents will be written to the error view if the document is missing a value to be substituted into the query/statement.
If a select query is executed, the query's results are merged into the incoming document and any existing keys will have their values overwritten. On the other hand, the original document is written if there are no results from the query.
The MySQL Execute Snap is for simple DML (SELECT, INSERT, UPDATE, DELETE) type statements. For the comprehensive scripting functionality offered by the various databases, users should use stored procedure functionality offered by their chosen database in the Stored Procedure Snap.
We recommend you to use the MySQL - Stored ProcedureSnap for invoking procedures as the My SQL Execute Snap cannot invoke procedures. To invoke procedures that contain OUT parameters, you must use two MySQL Execute Snaps—one for invoking the procedure and the other for printing the OUT parameters as shown below.
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:
Input
This Snap has at most one document input view. If the input view is defined, then the where clause can substitute incoming values for a given expression.
Output
This Snap has at most one document output view. If an output view is available and an update/insert/merge/delete statement was executed, then the original document that was used to create the statement will be output with the status of the statement executed.
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.
SQL statement
Required. Specifies the SQL statement to execute on the server.
There are two possible scenarios that you encounter when working with SQL statements in SnapLogic. You must understand the following scenarios to successfully execute your SQL statements:
Scenario 1: Executing SQL statements without expressions If the expression toggle of the SQL statement field is not selected:
The SQL statement must not be within quotes.
The $<variable_name> parts of the SQL statement are expressions. In the below example, $id and $book.
Additionally, the JSON path is allowed only in the WHERE clause. If the SQL statement starts with SELECT (case-insensitive), the Snap regards it as a select-type query and executes once per input document. If not, it regards it as a write-type query and executes in batch mode.
Scenario 2: Executing SQL queries with expressions If the expression toggle of the SQL statement field is selected:
The SQL statement must be within quotes.
The + $<variable_name> + parts of the SQL statement are expressions, and must not be within quotes. In the below example, $tablename.
The $<variable_name> parts of the SQL statement are bind parameter and must be within quotes. In the below example, $id and $book.
Table name and column names must not be provided as bind parameters. Only values can be provided as bind parameters.
Examples:
"EMPNO=$EMPNO and ENAME=$EMPNAME"
"emp='" + $emp + "'"
"EMPNO=" + $EMPNO + " and ENAME='" + $EMPNAME+ "'"
When the SQL statement property is an expression, the pipeline parameters are shown in the suggest, but not the input schema.
The non-expression form uses bind parameters, so it is much faster than executing N arbitrary SQL expressions.
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 the concatenation of strings with '=' Expression enabled.
The '$' sign and identifier characters, such as double quotes (“), single quotes ('), or back quotes (`), are reserved characters and should not be used in comments or for purposes other than their originally intended purpose.
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 value
Use
Has no single quotes
Schaum Series
'Schaum Series'
Contains single quotes
O'Reilly's Publication
'O''Reilly''s Publication' OR 'O\'Reilly\'s Publication'
Default value: [None]
We recommend you to add a single query in the SQL Statement field.
Query type
Select the type of query for your SQL statement (ReadorWrite).
WhenAutois selected, the Snap tries to determine the query type automatically. If the execution result of the query is not as expected, you can change the query type toReadorWrite.
Default Value: Auto Example:Read
Pass through
If selected, the input document will be passed through to the output view under the key 'original'. This property applies only to the Execute Snaps with SELECT statement.
Default value: Selected
Ignore empty result
If selected, no document will be written to the output view when a SELECT operation does not produce any result. If this property is not selected and the Pass through property is selected, the input document will be passed through to the output view.
Default value: Not selected
Auto commit
Select one of the options for this property to override the state of the Auto commit property on the account. The Auto commit at the Snap-level has three values: True, False, and Use account setting. The expected functionality for these modes are:
True - The Snap will execute with auto-commit enabled regardless of the value set for Auto commit in the Account used by the Snap.
False - The Snap will execute with auto-commit disabled regardless of the value set for Auto commit in the Account used by the Snap.
Use account setting - The Snap will execute with Auto commit property value inherited by the Account used by the Snap.
Default value: Use account setting
You can enable the Auto commit for certain use cases if JDBC driver is used in MySQL Snaps. But the JDBC driver may cause out of memory issues when Select statements are executed. In such cases, Auto commit in Snap property should be set to False and the Fetch size in the Account setting can be increased for optimal performance.
Behavior of DML Queries in Database Execute Snap when auto-commit is false
DDL queries used in the Database Execute Snap will be committed by the Database itself, regardless of the Auto-commit setting. When Auto commit is set to false for the DML queries, the commit will be called only at the end of the pipeline lifecycle. Instead of building multiple Snaps with inter-dependent DML queries, it is recommended to use Stored Procedure and Multi Execute Snap. The Auto commit needs to be true in a scenario where the downstream Snap does depend on the data processed on an Upstream Database Execute Snap containing a DML query. When the Auto commit is set to the Use account setting on the Snap, the account level commit needs to be enabled.
Number of retries
Specify the maximum number of retry attempts the Snap must make in case there is a network failure and is unable to read the target file. The request is terminated if the attempts do not result in a response.
If the Number of retries value is set to 0 (the default value), the retry option is disabled, and the Snap does not initiate a retry. The pipeline will not attempt to retry the operation in case of a failure—any failure encountered during the database operation will immediately result in the pipeline failing without any retry attempts to recover from the errors.
If the Number of retries value is greater than 0, the Snap initiates a download of the target file into a temporary local file. If any error occurs during the download, the Snap waits for the time specified in the Retry interval and then attempts to download the file again from the beginning. After the download is successful, the Snap streams the data from the temporary file to the downstream pipeline. All temporary local files are deleted when they are no longer needed.
Ensure that the local drive has sufficient free disk space to store the temporary local file.
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.
Example
In this pipeline, the MySQL Execute Snap creates a table pqadb.TAM_SAMPLE_PERSONS_2, with the required field names and the data type. The Snap settings and the output preview after the pipeline execution is as displayed below:
Snap Pack History
Click to view/expand
Release
Snap Pack Version
Date
Type
Updates
August 2024
main27765
Stable
Updated and certified against the current Snaplogic Platform release.
May 2024
437patches26298
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 nulltable metadata.
May 2024
main26341
Stable
Updated the Delete Condition (Truncates a Table if empty) field in the MySQL - DeleteSnap 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 2024
436patches25659
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 morein 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 stringformat or Date-only date format.
February 2024
main25112
Stable
Updated and certified against the current SnapLogic Platform release.
November 2023
main23721
Stable
Updated 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 2023
432patches19870
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 2023
main19844
Stable
Upgraded with the latest SnapLogic Platform release.
November 2022
431patches19263
Latest
The MySQL Insert Snap no longer includes the Preserve case-sensitivitycheckboxbecause 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 2022
main18944
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 2022
430patches17894
Latest
The MySQL Select Snap now work as expected when the table name is dependent on an upstream input;
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 2022
main17386
Stable
Upgraded 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.28
main14627
Stable
Updated the label for Delete Condition to Delete Condition (Truncates Table if empty) in the MySQL DeleteSnap.
4.27
main12833
Stable
Enhanced the MySQL Database Accountto 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.26
main11181
Stable
Upgraded with the latest SnapLogic Platform release.
4.25
425patches11008
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.25
main9554
Stable
Upgraded with the latest SnapLogic Platform release.
4.24
main8556
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 InSchema. 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 Patch
423patches7732
Latest
Fixes an issue in the MySQL - Bulk LoadSnap to support the following versions:
MySQL 8.0.17
MySQL 5.6.34
4.23
main7430
Stable
Upgraded with the latest SnapLogic Platform release.
4.22 Patch
422patches6629
Latest
Fixes the MySQLSnap Pack by acknowledging the lineage information of the original document in an empty output view whenPass Throughis enabled.
4.22
main6403
Stable
Upgraded with the latest SnapLogic Platform release.
4.21 Patch
421patches6272
Latest
Fixes the issue whereSnowflake SCD2Snap generates two output documents despite no changes toCause-historizationfieldswithDATE, TIME and TIMESTAMPSnowflake data types, and withIgnore unchanged rowsfield selected.
4.21 Patch
421patches6144
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 inConfiguring MySQL Accounts.
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
snapsmrc542
Stable
Upgraded 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.20
snapsmrc535
Stable
Upgraded 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 theConfigure SSH Tunnelproperty 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 theUpdate conditionproperty.
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.19
snaprsmrc528
Stable
Upgraded 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.18
snapsmrc523
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 insnapsmrc515) 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.17
ALL7402
Latest
Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17
snapsmrc515
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 Patch
MULTIPLE7123
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.16
snapsmrc508
Stable
Upgraded with the latest SnapLogic Platform release.
4.15 Patch
MULTIPLE6413
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
ReplacedMax idle timeandIdle connection testperiodproperties withMax life timeandIdle 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.15
snapsmrc500
Stable
Upgraded with the latest SnapLogic Platform release.
4.14
snapsmrc490
Stable
Upgraded with the latest SnapLogic Platform release.
4.13
snapsmrc486
Stable
Upgraded 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
Stable
Upgraded with the latest SnapLogic Platform release.
4.11
snapsmrc465
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 Patch
mysql3988
Latest
SSH Tunnelling related properties added at the Account level for both MySQL Dynamic Account and MySQL Database Account.
4.10
snapsmrc414
Stable
AddedAuto commitproperty to the Select and Execute Snaps at the Snap level to support overriding of theAuto commitproperty 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.9
snapsmrc405
Stable
Upgraded with the latest SnapLogic Platform release.
4.8.0 Patch
mysql2755
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.6
snapsmrc362
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.1
NA
Stable
Upgraded with the latest SnapLogic Platform release.
4.4
NA
Stable
Upgraded with the latest SnapLogic Platform release.
4.3.2
NA
Stable
NEW! MySQL Lookup Snap
Improved performance of the MySQL Execute Snap.
4.3
NA
NA
Stable
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
NA
NA
Stable
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.