In this article
...
You can use this Snap to execute a SQL statement/query against a SQL database. This Snap also supports DCL commands (Grant and Revoke).
This Snap works only with single queries.
This Snap only supports conversion of standard JDBC specification 4.1 types listed here. Learn more about the JDBC 4.1 specification. If you want database-specific conversion, then a database specific Snap pack should be used. For example, for handling TIMESTAMPTZ and TIMESTAMPLTZ formats, you should use the Oracle Snap Pack.
The Generic JDBC Execute Snap is used for simple DDL (SELECT, INSERT, UPDATE, DELETE) type statements. This Snap also supports DML operations (CREATE, ALTER, INSERT, and SELECT) when using AWS Athena database.
...
Field Name | Field Type | Description |
|---|
Label* Default Value: Generic JDBC - Execute
Example: Execute EmployeeRecords | 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
Example: INSERT into SnapLogic.book (id, book) VALUES ($id,$book)
| String/Expression | Specify the SQL statement to execute on the server. 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. | Info |
|---|
Scenarios to successfully execute your SQL statementsScenario 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. If not, it regards it as write-type query and executes in batch mode. Scenario 2: Executing SQL queries with 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+ "'"
|
Table name and column names must not be provided as bind parameters. Only values can be provided as bind parameters. We recommend you use the Oracle - Stored Procedure Snap for invoking procedures when using Oracle database with this Snap due to the following limitation while invoking procedures: Procedures have to invoked as a PL/SQL block (with older JDBC JARs). However, with this approach the output parameters cannot be sent to the output view. Besides, the latest oracle JDBC drivers do not support PL/SQL.
The non-expression form uses bind parameters, so it is much 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.
| Warning |
|---|
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. For example: |
| If String | To pass this value | Use |
|---|
| Has no single quotes | Schaum Series | 'Schaum Series'
| | Contains single quotes | O'Reilly's Publication
| 'O''Reilly''s Publication' |
Values can be substituted into the query/statement by using a JSON path using a $ to start the path.
For example, for the given document data: | Code Block |
|---|
{
"firstName": "John"
} |
During design time if you specify query such as,select * from users where first_name = $firstName, then the run-time query is: select * from users where first_name = "John" To invoke procedures when using Oracle database with this Snap, we recommend you use the Oracle Stored Procedure Snap. |
|---|
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. |
|---|
Pass through Default Value: Selected | Checkbox | Select this checkbox to pass the input data 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. If you deselect this checkbox and select the 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 attempts to be made to receive a response. The request is terminated if the attempts do not result in a response. If you provide a string value, the Snap displays the following error:
Invalid type (STRING) for property, expecting a value of type integer You can use a string value only when the field is expression-enabled. |
|---|
Retry interval (seconds) Default Value: 1
Example: 10 | Integer/Expression | Specifies 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 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.
Auto commit may be enabled for certain use cases if the PostgreSQL JDBC driver is used in either Redshift, PostgreSQL, or the generic JDBC Snap. However, the JDBC driver may cause out of memory issues when SELECT statements are executed. In those cases, Auto commit in the Snap property should be set to False and the Fetch size in the Account settings can be increased for optimal performance. For a DB Execute Snap, assume that a stream of documents are passed to the input view of the Snap and the SQL statement property has JSON paths in the WHERE clause. If the number of documents are large, the Snap executes in more than one batch rather than executing one per each document. Each batch would contain a certain number of WHERE clause values. If Auto commit is turned on, a failure would only roll back the records in the current batch. If Auto commit is turned off, the entire operation would be rolled back. For a single execute statement (with no input view), the setting has no practical effect.
| Multiexcerpt include macro |
|---|
| name | DDL Auto Commit |
|---|
| page | PostgreSQL - Execute |
|---|
|
|
|---|
| Multiexcerpt include macro |
|---|
| name | Snap Execution |
|---|
| page | SOAP Execute |
|---|
|
Default Value: Execute only
Example: Validate & Execute | Dropdown list | | Multiexcerpt include macro |
|---|
| name | Execution_Detail_Write |
|---|
| page | SOAP Execute |
|---|
|
|
|---|
...
