Overview

You can use the Azure SQL - Execute Snap to execute simple DML (SELECT, INSERT, UPDATE, DELETE) type statements.

This Snap works only with single queries.
For the comprehensive scripting functionality offered by the various databases, we recommend you use the stored procedure functionality offered by their chosen database in the Stored Procedure Snap.

Snap Type

The Azure SQL Execute Snap is a WRITE-type Snap that writes the results of the executed SQL queries.

Prerequisites

Valid Azure Synapse SQL Account.
Access to Azure Synapse SQL and the required permissions to execute T-SQL queries.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Supported Versions

This Snap supports SQL Server 2008 or higher version.

Limitations

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

Known Issues

None.

Behavior Change

Snap Views

Type	Format	Number of Views	Examples of Upstream and Downstream Snaps	Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 0
Max: 1

Mapper
Copy
JSON Generator

The dynamic variables used in the execute query can be defined by providing values upstream.
If the input view is defined, then the where clause substitutes incoming values for a specific query.

Output

Document

Min: 0
Max: 1

JSON Formatter
Any document processing Snap can be used downstream.

The Snap produces documents in the output 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.

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:

Stop Pipeline Execution: Stops the current Pipeline execution when the Snap encounters an error.
Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.
Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates 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	Field Type	Description

Field	Field Type	Description
Label Default Value: Azure SQL - Execute Example: Azure SQL - Execute	String	Specify a unique name for the Snap.
SQL statement* Default Value: N/A Example: select from “dob”, “Persons”*	String/Expression	Specify the SQL statement to execute on the server. When working with SQL statements in SnapLogic, you may encounter two possible scenarios. Learn more about scenarios to execute your SQL statements. We recommend you add a single query in the SQL Statement field. Valid JSON paths defined in the WHERE clause for queries/statements will be substituted with values from an incoming document. If a document is missing a value to be substituted into the query/statement, it will be written to the error view. 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. Be cautious when running your queries, because you can drop your database and lock tables while executing SQL statements. When trying to access a column name that contains specific characters supported by Azure SQL, such as $, #, @, such field names should be enclosed in square brackets.
Query type Default Value: Auto Example: Read	Dropdown list/Expression	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.
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 if you want the Snap to ignore empty fields and not write any document 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.
Number of Retries Default Value: 0 Example: 3	Integer/Expression	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.
Retry Interval (Seconds) Default Value: 1 Example: 10	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 Example: True	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: 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. '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.
Snap Execution Default Value: Validate & Execute Example: Execute only	Dropdown list