/
MySQL - Execute

MySQL - Execute

May 15, 2026

This page is no longer maintained (May 13, 2026). For the most current information, go to MySQL - Execute

On this Page

Snap type:

Write

 

Description:

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. 

Prerequisites:

[None]

Support

Works in Ultra Tasks.

Limitations

We recommend you to use the MySQL - Stored Procedure Snap 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.

Examples:



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:


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:

 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 (Read or Write).

When Auto is 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 to Read or Write.

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 of network failure. 

When you set the Number of retries to more than 0, the Snap generates duplicate records when the connection is not established. To prevent duplicate records, we recommend that you follow one of the following:

  • Set the Number of retries to 0 (default value) to prevent duplicate records from being passed downstream while executing a pipeline.

  • Use a Primary key to prevent records from being inserted into the database.

  • Use an Upsert instead of an Insert statement.

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

 

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: