Azure SQL - Execute
In this article
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 |
---|---|---|---|---|
Input | Document |
|
|
|
Output | Document
|
|
|
|
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. |
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 |
---|---|---|
Label
Default Value: Azure SQL - Execute | String | Specify a unique name for the Snap. |
SQL statement*
Default Value: N/A | 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.
|
Query type
Default Value: Auto | 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. |
Pass through Default Value: Selected | Checkbox | Select this checkbox to pass the input document to the output view under the key '
|
Ignore empty result
| 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 | Integer/Expression | Specify the maximum number of retry attempts the Snap must make in case there is a network failure and is unable to read the target file. The request is terminated if the attempts do not result in a response.
|
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:
|
Snap Execution
Default Value: Validate & Execute | Dropdown list |
|
Additional Information
Scenarios to successfully execute your SQL statements
Scenario 1: Executing SQL statements without expressions.
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:
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.
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.
Examples:
If String | To pass this value | Use |
---|---|---|
Has no single quotes | Schaum Series | 'Schaum Series' |
Contains single quotes | O'Reilly's Publication | ' |
Examples
Azure SQL - Execute Snap as a Standalone Pipeline
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 Azure SQL - Execute 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:
Without Expression: Directly passing the required SQL statement in the Azure SQL Execute Snap.
With Expressions
Values from an upstream Snap: The JSON Generator Snap passes the values to be inserted into the table on Azure.
Pipeline Parameter: Pipeline parameter set to pass the required values to the Azure.
Extract, Transform, Load
The following example use case demonstrates a broader business logic involving the ETL transformations, that shows how typically in an enterprise environment, an execute functionality is used. 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 an Azure SQL table.
Read: Another Execute Snap is used to read the data from the newly loaded table on the Azure SQL database.
Downloads
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.