Page Comparison

On this Page

Table of Contents

maxLevel	2
exclude	Older Versions\|Additional Resources\|Related Links\|Related Information

Snap type:

Write

Description:

This Snap allows you to execute arbitrary SQL.

Note
You can drop your database with it, so be careful.

This Snap supports SQL Server 2008 or newer.

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. 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.

Expected upstream Snaps: The dynamic variables used in the execute query can be defined by providing values upstream. The document generator Snaps like JSON Generator can be used in upstream.

Expected downstream Snaps: The Snap will output one document for every record retrieved, hence any document processing Snap can be used downstream.
The SQL Server 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.

Note
While trying to access a column name that contains specific characters as supported by Azure SQL such as $, #, @ etc., such field names should be enclosed in the square brackets.

Modes

Works in Ultra Pipelines.

Prerequisites: [None]

Limitations and Known Issues:

When the SQL statement property is an expression, the pipeline parameters are shown in the suggest, but not the input schema.

Behavior Change

Multiexcerpt macro

name	Behavior change in Database Execute Snaps

In 4.26, when the stored procedures were called using the Database Execute Snaps, the queries were treated as write queries instead of read queries. So the output displayed message and status keys after executing the stored procedure.
In 4.27, all the Database Execute Snaps run stored procedures correctly, that is, the queries are treated as read queries. The output now displays message key, and OUT params of the procedure (if any). The status key is not displayed.

If the stored procedure has no OUT parameters then only the message key is displayed with value success.

If you have any existing Pipelines that are mapped with status key or previous description then those Pipelines will fail. So, you might need to revisit your Pipeline design.

Configurations:

Account & Access

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Azure SQL Account for information on setting up this type of account.

Views

Input

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

This Snap allows zero or one output view and produces documents in the view.

Error

This Snap has at most one 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.

Troubleshooting: None

Settings

Label*

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*

Specifiy the SQL statement to execute on the server. There are two possible scenarios that you encounter when working with SQL statements in SnapLogic.

Info

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

Multiexcerpt macro

name	ME_DB_Execute_Snaps_Scenario1

email = 'you@example.com' or email = $email
emp=$emp

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:

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.

Multiexcerpt macro

name	ME_DB_Execute_Snaps_Scenario2

"EMPNO=$EMPNO and ENAME=$EMPNAME"
"emp='" + $emp + "'"
"EMPNO=" + $EMPNO + " and ENAME='" + $EMPNAME+ "'"

Note
Table name and column names must not be provided as bind parameters. Only values can be provided as bind parameters.

Examples:

Note

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 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.

Warning

title	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. Ensure that you pass two consecutive single quotes in place of one within these values to escape the single quote 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`'

Default value: [None]

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

Note
'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.

Multiexcerpt include macro

name	DDL Auto Commit
page	PostgreSQL - Execute

Multiexcerpt include macro

name	Snap Execution
page	SOAP Execute

Multiexcerpt include macro

name	Execution_Detail_Write
page	SOAP Execute

Basic Use Case

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

Extract: The SQL statement, select * from <table_name>, extracts the Azure table data.

Typical Snap Configurations

The key configuration of the Snap lies in how you pass the SQL statement to read Azure records. As it applies in SnapLogic, you can pass SQL statements in the following manner:

32735236

Without Expression: Directly passing the required SQL statement in the Azure SQL Execute Snap.

With Expressions
- Values from an upstream Snap: JSON Generator Snap passing the values to be inserted on to the table on Azure.

- Pipeline Parameter: Pipeline parameter set to pass the required values to the Azure.

Use Case

The following describes a pipeline, with a broader business logic involving the ETL transformations, that shows how typically in an enterprise environment, an execute functionality is used. Pipeline download link below.

This pipeline reads and moves files from the SQL Server Database to the Azure SQL Database and the Azure SQL Execute Snap reads the newly loaded table on the Azure SQL instance.

Extract: The SQL Server Select Snap reads the data from the SQL Server Database.
Load: The Azure SQL Execute Snap inserts the data into a Azure SQL table.
Read: Another Execute Snap is used to read the data from the newly loaded table on the Azure SQL database.

Downloads

Multiexcerpt include macro

name	download_instructions
page	OpenAPI

Attachments

upload	false
old	false
patterns	.slp, .zip

Insert excerpt

	Azure SQL Snap Pack
	Azure SQL Snap Pack
nopanel	true

Versions Compared

Old Version 37

New Version 38

Key

Modes

Account & Access

Views

Settings

Basic Use Case

Typical Snap Configurations

Use Case

Downloads