In this article
You can use this Snap to execute arbitrary SQL queries. This Snap works only with single queries.
|
SQL Server - Execute Snap is a Write-type Snap that executes an SQL Server statement/query.
None.
Works in Ultra Pipelines.
When the SQL statement property is an expression, the pipeline parameters are shown in the suggest, but not the input schema.
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.
|
|
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.
Single quotes in values must be escaped Any relational database (RDBMS) treats single quotes ( Single quotes in values must be escaped Any relational database (RDBMS) treats single quotes (
| |||||||||
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 attempts to be made to receive a response. The request is terminated if the attempts do not result in a response. Ensure that the local drive has sufficient free disk space to store the temporary local file. Ensure that the local drive has sufficient free disk space to store the temporary local file. | |||||||||
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. '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. | |||||||||
Default Value: Execute only | Dropdown list |
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'
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 a write-type query and executes in batch mode. |
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+ "'"
|
Error | Reason | Resolution |
---|---|---|
| Incorrect syntax near 'GO'. | Rewrite the query without ‘GO’ and run it. |
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.
Important steps to successfully reuse Pipelines
|