SQL Server - Execute
In this article
Overview
You can use this Snap to execute arbitrary SQL queries. This Snap works only with single queries.
You can drop your database with the execution, so we recommend you to be cautious.
You can execute stored procedures containing IN, OUT, INOUT parameters using this Snap.
Snap Type
SQL Server - Execute Snap is a Write-type Snap that executes an SQL Server statement/query.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations & Known Issues
When the SQL statement property is an expression, the pipeline parameters are shown in the suggest, but not the input schema.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| 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 | Document |
|
| This Snap allows zero or one output view and produces documents in the view. |
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. 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. |
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether 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: SQL Server - Execute | String | 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*
Default Value: N/A
| String/Expression
| Specify the SQL statement to execute on the server. Learn more about how to execute 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 'original'. This property applies only to the Execute Snaps with SELECT statement.
|
Ignore empty result
Default Value: Deselected | Checkbox | Select this checkbox to ignore empty result; no document is written to the output view when a SELECT operation does not produce any result. |
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:
|
Default Value: Execute only | Dropdown list |
Execute SQL statements
Without expressions
If you do not enable the expression toggle of the SQL statement field, then:
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'
oremail = $email
emp=$emp
With expressions
If you enable the expression toggle of the SQL statement field, then:
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:
"EMPNO=$EMPNO and ENAME=$EMPNAME"
"emp='" + $emp + "'"
"EMPNO=" + $EMPNO + " and ENAME='" + $EMPNAME+ "'"
Troubleshooting
Error | Reason | Resolution |
---|---|---|
| Incorrect syntax near 'GO'. | Rewrite the query without ‘GO’ and run it. |
Example
In this example, we have a table named "customer1" that stores user details. It has the columns: product, phoneno, customername, city, country. We will execute the query and retrieve customers with given name.
We need to provide the query used to pull the data from customer1 table in SQL statement property. We will provide dynamic variable values from the upstream JSON Generator Snap. On Validation, the Snap displays the output.
|