...
In this
...
article
Table of Contents | ||||
---|---|---|---|---|
|
...
Write
...
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.
...
Overview
You can use the Azure SQL - Execute Snap to execute single simple DML (SELECT, INSERT, UPDATE, DELETE) type statements.
This Snap work only with single queries. If you want to run multiple queries, we recommend you to use the Azure Multi Execute Snap.
For the comprehensive scripting functionality offered by the various databases,
...
we recommend you to use the stored procedure functionality offered by their chosen database in the Stored Procedure Snap.
Note |
---|
You can drop your database with it, so be careful. 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 |
...
. |
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
Multiexcerpt macro | ||
---|---|---|
| ||
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. |
...
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
...
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
|
|
...
|
...
|
Output |
...
Document
|
|
|
|
...
|
...
Settings
Label*
...
| ||||
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
Info |
---|
|
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 | Specifiy the SQL statement to execute on the server. There are two possible scenarios that you encounter when working with SQL statements in SnapLogic. |
...
Learn more about scenarios to execute your SQL statements.
| ||||||||
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 the Snap is unable to read the target file. 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. | ||||||
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.
| ||||||
Snap Execution | 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:
Multiexcerpt macro | ||
---|---|---|
| ||
|
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.
Multiexcerpt macro | ||
---|---|---|
| ||
|
Note |
---|
Table name and column names must not be provided as bind parameters. Only values can be provided as bind parameters. |
Examples:
...
Note |
---|
|
Warning |
---|
...
Single quotes in values must be escapedAny relational database (RDBMS) treats single quotes ( For example: |
If String | To pass this value | Use |
---|---|---|
Has no single quotes | Schaum Series |
|
Contains single quotes |
| 'O''Reilly''s ' |
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 | ||||
---|---|---|---|---|
|
...
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
...
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
Basic Use Case
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
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
Attachments | ||||||
---|---|---|---|---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|