In this article
Overview
You can use this Snap to execute arbitrary SQL query. This Snap supports SQL Server 2008 or a later version.
Valid JSON paths that are defined in the WHERE clause for queries/statements will be substituted with values from an incoming document. Documents are 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. 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.
You can drop your database with the execution, so we recommend you to be cautious.
You can execute stored procedures containing IN, OUT, INOUT parameters using this Snap.
Snap Type
SQL Server - Execute Snap is a Write-type Snap that executes an SQL Server statement/query.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations & Known Issues
When the SQL statement property is an expression, the pipeline parameters are shown in the suggest, but not the input schema.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| This Snap allows zero or one input views. If the input view is defined, then the where clause can substitute incoming values for a given expression. |
Output | Document |
|
| This Snap allows zero or one output view and produces documents in the view. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. 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. |
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the field set.
Remove icon (): Indicates that you can remove fields from the field set.
Field Name | Field Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Label* Default Value: SQL Server - Execute | String | Specify 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* Default Value: N/A | String/Expression | Specify the SQL statement to execute on the server.
Scenarios to successfully execute your SQL statementsScenario 1: Executing SQL statements without expressions If the expression toggle of the SQL statement field is not selected:
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 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:
Examples:
Single quotes in values must be escapedAny relational database (RDBMS) treats single quotes ( For example:
| |||||||||
Pass through Default Value: Selected | Checkbox | Select this checkbox to pass the input document to the output view under the key 'original'. This property applies only to the Execute Snaps with SELECT statement. | |||||||||
Ignore empty result Default Value: Deselected | Checkbox | Select this checkbox to ignore empty result; no document is written to the output view when a SELECT operation does not produce any result. | |||||||||
Number of retries Default Value: 0 | Integer/Expression | Specify 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. Ensure that the local drive has sufficient free disk space to store the temporary local file. | |||||||||
Retry interval (seconds) Default Value: 1 | Integer/Expression | Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. | |||||||||
Auto commit Default value: Use account setting | Dropdown list | 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:
'Auto commit' may be enabled for certain use cases if PostgreSQL jdbc driver is used in either Redshift, PostgreSQL or generic JDBC Snap. But the JDBC driver may cause out of memory issues when Select statements are executed. In those 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 is called at the end of the Snap's execution. 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. | |||||||||
Snap execution Default Value: Execute only | Dropdown list | Select one of the three modes in which the Snap executes. Available options are:
|
Troubleshooting
Error | Reason | Resolution |
---|---|---|
| Incorrect syntax near 'GO'. | Rewrite the query without ‘GO’ and run it. |
Example
In this example, we have a table named "customer1" that stores user details. It has the columns: product, phoneno, customername, city, country. We will execute the query and retrieve customers with given name.
We need to provide the query used to pull the data from customer1 table in SQL statement property. We will provide dynamic variable values from the upstream JSON Generator Snap. On Validation, the Snap displays the output.
Downloads
Important steps to successfully reuse Pipelines
Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.
Release | Snap Pack Version | Date | Type | Updates |
---|---|---|---|---|
August 2024 | main27765 | Stable | Updated and certified against the current Snaplogic Platform release. | |
May 2024 | 437patches27732 | Latest | Fixed an issue with the SQL Server - Select Snap configured with an Ultra task to handle temporary database unavailability. The Snap now validates the database connection to ensure that it is reestablished after temporary database outages. | |
May 2024 | 437patches27328 |
| Latest | Fixed an issue with the SQL Server Insert Snap that caused an error when inserting the infinity value into a |
May 2024 | 437patches27091 |
| Latest | Fixed a case-sensitivity issue with the SQL Server—Bulk Load Snap that caused a |
May 2024 | main26341 |
| Stable | Updated the Delete Condition (Truncates a Table if empty) field in the SQL Server - 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 | 436patches26177 |
| Latest |
|
February 2024 | 436patches25757 |
| Latest | Fixed an issue with the SQL Server - Insert Snap that previously displayed an error when attempting to insert a true or false value into a |
February 2024 | 436patches25548 |
| Latest |
Behavior change: |
February 2024 | main25112 |
| Stable | As of |
November 2023 | main23721 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
August 2023 | 434patches22758 |
| Latest | Fixed an issue with the SQL Server Stored Procedure and Table List Snaps that caused no retries to be executed even if you select the number of retries in the UI when a custom JDBC driver was used. |
August 2023 | 434patches22579 |
| Latest | Improved the SQL Server Bulk Load Snap to reduce the chance of causing a deadlock error. |
August 2023 | main22460 |
| Stable | The SQL Server - Execute Snap now includes a new Query type field. When Auto is selected, the Snap tries to determine the query type automatically. |
May 2023 | 433patches22090 |
| Latest | The SQL Server Stored Procedure and SQL Server Table List Snaps now support the retry functionality. |
May 2023 | 433patches21808 |
| Latest |
|
May 2023 | 433patches21386 |
| - | The SQL Server Snap Pack is upgraded to the latest version of the Microsoft JDBC Driver 12.2.0.jre11 for SQL Server:
The Microsoft JDBC Driver |
May 2023 | 433patches21119 |
| Latest | Updated the Bulk Load Snap to preserve empty strings as empty strings and null as nulls. |
May 2023 | main21015 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
February 2023 | main19844 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
November 2022 | 431patches19263 |
| Latest | The SQL Server Insert Snap no longer 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 | 431patches19268 |
| Latest | The SQL Server-Insert Snap now displays the error, |
November 2022 | 431patches19234 |
| Latest | A memory leak in the SQL Server Stored Procedure Snap is fixed. The Snap now clears the closed connections from memory and retains the open connections. |
November 2022 | 431patches19000 |
| Stable/Latest | The SQL Server accounts failed with a certificate error on Windows Snaplexes when using the default SQL driver with the |
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:
|
August 2022 | 430patches17064 |
| Latest | The SQL Server - Select Snap now has the Convert rowversion datatype to integer checkbox to support the |
4.30 Patch | 430patches17368 |
| Latest | The SQL Server Execute Snap containing an explicit SQL transaction now works as expected when using a default JDBC driver. |
August 2022 | main17386 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.29 Patch | 429patches16235 |
| Latest | Fixed an issue with SQL Server Execute Snap where the Snap did not display a valid error message when the delete condition is invalid. |
4.29 | main15993 |
| Stable | Enhanced the SQL Server - Bulk Load Snap with the Batch Size field to process records in a batch. |
4.28 Patch | 428patches14649 |
| Latest | Enhanced the SQL Server - Select and SQL Server - Lookup Snaps with Option for Unique Identifier Column that allows you to convert the case to lower or upper while displaying the Unique Identifier output (display) value. |
4.28 | main14627 |
| Stable | Updated the label for Delete Condition to Delete Condition (Truncates Table if empty) in the SQL Server Delete Snap. |
4.27 | main12833 |
| Stable | Enhanced the SQL Server - Execute Snap to invoke stored procedures. |
4.26 Patch | 426patches12535 | Latest | Fixed an issue in the SQL Server Bulk Load snap where boolean data type failed to load into BIT field. | |
4.26 | main11181 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.25 Patch | 425patches10797 |
| Latest | Fixed an issue with the SQL Server - Bulk Load Snap where the Snap fails when the login password contains a colon or a less than (<) symbol. |
4.25 | main9554 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.24 Patch | 424patches8657 |
| Latest | Enhances the SQL Server - Select Snap by introducing a new field, Query Hints, which helps to customize and optimize the database engine to process query statements. |
4.24 | main8556 | Stable |
| |
4.23 Patch | 423patches8190 |
| Latest | Fixes an issue with SQL Server - Execute to handle SQL statements that begin with special characters. |
4.23 | main7430 |
| Stable | Enhances the accounts in this Snap Pack to allow Windows-based (Active Directory) authentication and user impersonation for SQL Server user accounts. |
4.22 Patch | 422patches6728 |
| Latest | Enhances the SQL Server Snap pack to allow Windows (Active Directory) based authentication and user impersonation for SQL Server user accounts. |
4.22 | main6403 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.21 Patch | 421patches6272 |
| 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 |
| Latest | Fixes the following issues with DB Snaps:
|
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 Patch | db/sqlserver8837 |
| Latest | Fixed the SQL Server - Stored Procedure Snap to support the UUID datatype. |
4.21 | snapsmrc542 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.20 Patch | db/sqlserver8793 |
| Latest | Fixed an issue in the SQL Server - Insert Snap due to which the Snap failed to load values of data type INT. |
4.20 Patch | db/sqlserver8796 |
| Latest | Fixed the SQL Server - Bulk Load Snap to mask the password in the logged exception messages. |
4.20 | snapsmrc535 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.19 Patch | db/sqlserver8413 |
| Latest | Fixed an issue with the SQL Server - Update Snap wherein the Snap is unable to perform operations when:
|
4.19 | snaprsmrc528 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.18 Patch | db/sqlserver7989 |
| Latest | Fixed an issue in the SQL Server - Merge Snap wherein identity columns are not handled correctly. Also, added a field, Enable Identity Insert, that enables you to insert values into an identity column. |
4.18 | snapsmrc523 |
| Stable |
|
4.17 Patch | MULTIPLE7479 |
| Latest | Fixed an issue with the SQL Server - Lookup Snap wherein it fails a UUID search. |
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 |
|
4.16 Patch | db/sqlserver6981 |
| Latest | Fixed an issue of slow performance in SQL Server Snaps while using SQL Server Dynamic account type. |
4.16 Patch | db/sqlserver6818 |
| 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 | db/sqlserver6337 |
| 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 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.14 Patch | db/sqlserver5912 |
| Latest | Fixed an issue to parse the right data type and display it in the input schema for SQL Server Snap.. |
4.14 Patch | db/sqlserver5665 |
| Latest | Implemented a connection retry logic in the SQL Server account to resolve the connection loss issue in a customer's org. |
4.14 | snapsmrc490 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.13 | snapsmrc486 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.12 | snapsmrc480 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.11 Patch | db/sqlserver4388 |
| Latest | Fixed an issue with the Stored Procedure Snap that does not maintain the columns' order on the output as per table's definition. |
4.11 Patch | db/sqlserver4288 |
| Latest | SQL Server Snap Pack - Fixed an issue when inserting a valid NaN value into a column. |
4.11 | snapsmrc465 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.10 Patch | sqlserver3953 |
| Latest | Fixed an issue where the SQL Server Stored Procedure gets hanged when more than one Snap existed in the pipeline each processing greater than 1K documents. |
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 | sqlserver3224 |
| Latest | Addressed an issue with SQL Server - Bulk Load execution even with 0 input documents |
4.9.0 Patch | sqlserver3076 |
| 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 | sqlserver2803 |
| Latest | Addressed an issue with slow performance with Bulk Load BCP. |
4.8.0 Patch | sqlserver2761 |
| Latest | Potential fix for JDBC deadlock issue. |
4.8.0 Patch | sqlserver2706 |
| Latest | Fixed SQL Server Snap Pack rendering dates that are one hour off from the date returned by database query for non-UTC Snaplexes. |
4.8 | snapsmrc398 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.7 | snapsmrc382 |
| Stable |
|
4.6 | snapsmrc362 |
| Stable |
|
4.5.1 | snapsmrc344 |
| Latest | Upgraded with the latest SnapLogic Platform release. |
4.5 | snapsmrc344 |
| Stable |
|
4.4.1 | NA |
| Latest |
|