On this Page

Snap type:

Read

Description:

This Snap allows you to fetch data from a database by providing a table name and configuring the connection. The Snap produces the records from the database on its output view which can then be processed by a downstream Snap.

JSON paths can be used in a query and will have values from an incoming document substituted into the query. 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 overwriting any existing keys' values. The original document is output if there are no results from the query.

Queries produced by the Snap have an equivalent format:

SELECT * FROM [table] WHERE [where clause] ORDER BY [ordering] LIMIT [limit] OFFSET [offset]

If more powerful functionality is desired, then the Execute Snap should be used.

Hints

Retrieval of 0000-00-00 date time or timestamp values.

You need to set the following on the MySQL account in case you need to deal with 0000-00-00 defined datetime or timestamp values:

Url property name Url property value
zeroDateTimeBehavior convertToNull

This will return all 0000-00-00 defined values as null values. The JDBC driver does not support returning 0000-00-00 as timestamp or datetime values.

Prerequisites:

[None]

Support and limitations:

Works in Ultra Tasks.
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:

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 (in such as to use it as a lookup).
Output	A second view can be added to show the metadata for the table as a Document. The metadata document can then be fed into the second input view of MySQL Server - Insert or Bulk Load Snap so that the table is created in MySQL with a similar schema as the source table.
Error	This 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.

Example: SYS
Default value: [None]

Table name

Required. The name of table to execute insert on.
Example: people

Default value: [None]

Where clause

The WHERE clause of select statement. This supports document value substitution (such as $person.firstname will be substituted with the value found in the incoming document at the path).

Examples:

Without using expressions

EmpId = 12
email = 'you@example.com'

Using expressions

"EMPNO=$EMPNO and ENAME=$EMPNAME"
email = $email
emp=$emp
"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 is hence unsafe. Ensure that you understand all implications and risks involved before using concatenation of strings with '=' Expression enabled.

Order by

Enter in the columns in the order in which you want to order by. The default database sort order will be used.

Example:

name
email

Default value: [None]

Limit offset

Starting row for the query
Example: 0
Default value: [None]

Limit rows

Starting row for the query
Example: 0
Default value: [None]

Output fields

Enter or select output field names for SQL SELECT statement. To select all fields, leave it at default.

Example: email, address, first, last, etc.

Default value: [None]

Fetch Output Fields In Schema

Select this check box to include only the selected fields or columns in the Output Schema (second output view). If you do not provide any Output fields, all the columns are visible in the output.
If you provide output fields, we recommend you to select Fetch Output Fields In Schema check box.

Default value: Not selected

Pass through

If checked, the input document will be passed through to the output view under the key 'original'.

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

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.

If the value is larger than 0, the Snap first downloads 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 attempts to download the file again from the beginning. When 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

Match data types

Conditional. This property applies only when the Output fields property is provided with any field value(s).

If this property is selected, the Snap tries to match the output data types same as when the Output fields property is empty (SELECT * FROM ...). The output preview would be in the same format as the one when SELECT * FROM is implied and all the contents of the table are displayed.

Default value: Not selected

Staging mode

Required when the value in the Number of retries field is greater than 0.

Specify the location from the following options to store input documents between retries:

In memory: The query results are stored in the Snaplex memory. If the query is too large to fit in the memory space, it may cause the Snap to fail, choose the On disk option.
On disk: The query results are stored on the disk in a temporary (tmp) directory that is managed by the SnapLogic platform. This directory is deleted automatically when the Snap terminates.

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

For the 'Suggest' in the Order by columns and the Output fields properties, the value of the Table name property should be an actual table name instead of an expression. If it is an expression, it will display an error message "Could not evaluate accessor: ..." when the 'Suggest' button is clicked. This is because, at the time the "Suggest" button is clicked, the input document is not available for the Snap to evaluate the expression in the Table name property. The input document is available to the Snap only during the preview or execution time.

Example

In this pipeline, the MySQL Select Snap, retrieves the data from the database, formats to CSV using the CSV Formatter Snap and writes to a file using the File Writer Snap.

The MySQL Select Snap retrieves the records from pqadb.TAM_SAMPLE_PERSONS where the output fields are PersonID, FirstName, LastName, Address, City.

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

Upon execution, the File Writer Snap writes the output to a file as shown below:

Download the Pipeline.

Downloads

Important steps to successfully reuse Pipelines

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

	File	Modified
Labels No labels Preview View	File Example_MysQL_Select.slp	Feb 04, 2021 by Kalpana Malladi

Snap Pack History

Click to view/expand

Release	Snap Pack Version	Date	Type	Updates
November 2024	main29029	13 Nov 2024	Stable	Updated and certified against the current SnapLogic Platform release.
August 2024	main27765	21 Aug 2024	Stable	Updated and certified against the current Snaplogic Platform release.
May 2024	437patches26298	09 May 2024	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 2024	main26341	08 May 2024	Stable	Updated 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 2024	436patches25659	27 Mar 2024	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 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	main22460	16 Aug 2023	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	10 May 2023	Stable	Upgraded with the latest SnapLogic Platform release.
February 2023	432patches19870	23 Feb 2023	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	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	431patches19263	19 Dec 2022	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 2022	main18944	10 Nov 2022	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	15 Sep 2022	Latest	The MySQL Select Snap now work as expected when the table name is dependent on an upstream input;
August 2022	430patches17387	17 Aug 2022	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 2022	main17386	11 Aug 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.29	main15993	14 May 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.28 Patch	428patches15101	12 Apr 2022	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	12 Feb 2022	Stable	Updated the label for Delete Condition to Delete Condition (Truncates Table if empty) in the MySQL Delete Snap.
4.27	main12833	13 Nov 2021	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.26	main11181	14 Aug 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.25	425patches11008	04 Aug 2021	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	08 May 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.24	main8556	13 Feb 2021	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 Patch	423patches7732	14 Dec 2020	Latest	Fixes an issue in the MySQL - Bulk Load Snap to support the following versions: MySQL 8.0.17 MySQL 5.6.34
4.23	main7430	14 Nov 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.22 Patch	422patches6629	01 Sep 2020	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.22	main6403	12 Sep 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.21 Patch	421patches6272	27 Jul 2020	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 Patch	421patches6144	20 Jul 2020	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	20 May 2020	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 Patch	MULTIPLE8841	20 May 2020	Latest	Fixes the connection issue in Database Snaps by detecting and closing open connections after the Snap execution ends.
4.21	snapsmrc542	09 May 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.20 Patch	db/mysql8815	22 Apr 2020	Latest	Fixes the MySQL Stored Procedure Snap to resolve compatibility issues with the Amazon Aurora database.
4.20 Patch	db/mysql8786	30 Mar 2020	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	08 Feb 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.19 Patch	db/mysql8638	21 Jan 2020	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	21 Jan 2020	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	13 Dec 2019	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	13 Dec 2020	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	03 Dec 2019	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	14 Nov 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.18 Patch	db/mysql7846	23 Sep 2019	Latest	Fixed an issue with the MySQL Snaps wherein the Snaps exhibit degraded performance with snapsmrc523.
4.18	snapsmrc523	10 Aug 2019	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	10 Jun 2019	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	03 Jun 2019	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	11 Jun 2019	Latest	Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17	snapsmrc515	11 Jun 2019	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	22 Feb 2019	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	22 Feb 2019	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	16 Feb 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.15 Patch	MULTIPLE6413	02 Jan 2019	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	05 Dec 2018	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.15	snapsmrc500	15 Dec 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.14	snapsmrc490	11 Aug 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.13	snapsmrc486	12 May 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.12 Patch	db/mysql4924	03 Apr 2018	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	17 Feb 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.11	snapsmrc465	11 Nov 2017	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	21 Sep 2017	Latest	SSH Tunnelling related properties added at the Account level for both MySQL Dynamic Account and MySQL Database Account.
4.10	snapsmrc414	12 Aug 2017	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	01 Jun 2017	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	13 May 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.8.0 Patch	mysql2755	27 Mar 2017	Latest	Potential fix for JDBC deadlock issue.
4.8.0 Patch	mysql2695	22 Feb 2017	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	11 Feb 2017	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	28 Nov 2016	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	13 Dec 2016	Latest	MySQL Merge will now route documents to the output and error views correctly
4.7	snapsmrc382	23 Nov 2016	Stable	Added a new Snap, MySQL Bulk Load.
4.6	snapsmrc362	13 Aug 2016	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	18 May 2016	Stable	Fixed an error in a tooltip for MySQL - Select Snap.
4.5	snapsmrc344	18 May 2016	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	18 Mar 2016	Stable	Upgraded with the latest SnapLogic Platform release.
4.4	NA	13 Feb 2016	Stable	Upgraded with the latest SnapLogic Platform release.
4.3.2	NA	15 Jan 2016	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. Resolved a Java exception in MySQL Merge Snap.

MySQL - Select

Hints

Retrieval of 0000-00-00 date time or timestamp values.

Settings

Example

Downloads