...
You can use this Snap to execute Transact-SQL queries.
...
This Snap works only with single queries.
...
Snap Type
The Azure Synapse SQL - Execute Snap is a Write-type Snap that writes the results of the executed SQL queries.
...
This Snap fails to insert null values for date data types, because of an issue with the jOOQ auto cast() expression in the transformed query.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|
Input | Document | | | If the input view is defined, then the where clause substitutes incoming values for a specific query. |
Output | Document | | | 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 executed statement. |
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
Info |
---|
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 Name | Field Type | Description |
---|
Label* Default Value: Azure Synapse SQL - Execute Example: Execute EmployRecords | String | Specify a unique name for the Snap. |
SQL Statement* Default Value: Example: INSERT into SnapLogic.book (id, book) VALUES ($id,$book) | String/Expression | Specify the SQL statement to execute on the server. |
There We recommend you to add a single query in the SQL Statement field. There are two possible scenarios that you encounter when working with SQL statements in SnapLogic. 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. 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. Else, it regards it as write-type query and executes in batch mode. Scenario 2: Executing SQL queries using 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. "EMPNO=$EMPNO and ENAME=$EMPNAME"
"emp='" + $emp + "'"
"EMPNO=" + $EMPNO + " and ENAME='" + $EMPNAME+ "'"
Note |
---|
Do not specify Table name and column names as bind parameters. You can only provide values as bind parameters. |
The non-expression form uses bind parameters, so it is 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.
Info |
---|
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. |
|
Image RemovedImage Added |
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. |
Ignore empty result Default value: Deselected | Checkbox | Select this checkbox to enable the Snap to ignore empty result and not write a document to the output view when a SELECT operation does not produce any result. If you deselect this checkbox and with the default Pass through option, the input document is 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 there is a network failure |
---|
, the Snap is unable to read the target file. The request is terminated if the attempts do not result in a response. If the Number of retries value is set to 0 (the default value), the retry option is disabled, and the Snap does not initiate a retry. The pipeline will not attempt to retry the operation in case of a failure—any failure encountered during the database operation will immediately result in the pipeline failing without any retry attempts to recover from the errors. If the Number of retries value is
|
larger first downloads When PipelineEnsure that the local drive has sufficient free disk space to store the temporary local file. |
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 following options to override the state of Auto commit on the account: True - Executes with auto-commit enabled regardless of the value set for Auto commit in the Account used by the Snap. False - Executes with auto-commit disabled regardless of the value set for Auto commit in the Account used by the Snap. Use account setting - Executes 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 such cases, Auto commit in Snap should be set to False and the Fetch size in the Account settings can be increased for optimal performance. Info |
---|
Behavior of DML Queries in Database Execute Snap with respect to Auto Commit setting: 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: Validate & Execute Example: Execute only | Dropdown list | Select one of the three modes in which the Snap executes. Available options are: Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it.
|
Troubleshooting
Error | Reason | Resolution |
---|
Implicit conversion from data type varbinary to date is not allowed.
| This error is because of an issue with the jOOQ auto cast() expression in the transformed query. | Use the CONCAT reference for each value to run the query. |
Example
...
Fetch employee records from the
...
employee table
This example Pipeline demonstrates how to fetch employee records from the Employee table.
...
Info |
---|
Download and import the Pipeline pipeline into the SnapLogic application. Configure Snap accounts as applicable. Provide Pipeline pipeline parameters as applicable.
|
...
Expand |
---|
Insert excerpt |
---|
| Azure Synapse SQL Snap Pack |
---|
| Azure Synapse SQL Snap Pack |
---|
name | Azure_Synapse_SQL_SPH |
---|
nopanel | true |
---|
|
|
...
Related Content
...
...