Snap type: | Write
|
---|
Description: | This Snap allows you to execute arbitrary SQL. Info |
---|
This Snap works only with single queries. |
Note |
---|
You can drop your database with it, so be careful. |
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. 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. Expected downstream Snaps: The Snap will output one document for every record retrieved, hence any document processing Snap can be used downstream.
Note |
---|
The SAP HANA Execute Snap is for simple DML (SELECT, INSERT, UPDATE, DELETE) type statements. For the comprehensive scripting functionality offered by the various databases, users should use stored procedure functionality offered by their chosen database in the Stored Procedure Snap. |
|
---|
Prerequisites: | [None]
|
---|
Support and limitations: | Ultra pipelines: Works in Ultra Task Pipelines. Spark mode: Not supported in Spark mode. | Account: |
---|
Behavior Change | Multiexcerpt include macro |
---|
name | Behavior change in Database Execute Snaps |
---|
page | Azure SQL - Execute |
---|
|
|
---|
Account | This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring SAP HANA AccountAccounts for information on setting up this type of account.
|
---|
Views: |
Input | This Snap has at most one document input view. If the input view is defined, then the where clause can substitute incoming values for a given expression. |
---|
Output | This Snap has at most one document output view. 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. |
---|
Error | This Snap has at most one document error view and produces zero or more documents in the view. Note |
---|
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. |
|
---|
|
---|
Settings |
---|
Label*
| Required. The 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 pipelinePipeline. |
---|
SQL statement Required.*
| If selected, the input document will be passed through Specifies Specify the SQL statement to execute on the server. There are two possible scenarios that you encounter when working with SQL statements in SnapLogic. You must understand the following scenarios Info |
---|
title | 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.
| For exampleExamples: Image Modified Multiexcerpt include macro |
---|
name | ME_DB_Execute_Snaps_Scenario1 |
---|
page | Azure SQL - Execute |
---|
|
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.
|
Note |
---|
Table name and column names must not be provided as bind parameters. Only values can be provided as bind parameters. |
For exampleExamples:
Multiexcerpt include macro |
---|
name | ME_DB_Execute_Snaps_Scenario2 |
---|
page | Azure SQL - Execute |
---|
|
Info |
---|
We recommend you to add a single query in the SQL Statement field. |
Info |
---|
| When the SQL statement property is an expression, the pipeline parameters are shown in the suggest, but not the input schema. |
Note |
---|
- The non-expression form uses bind parameters, so it is much faster than executing N arbitrary SQL expressions. With the SQL statement property set as an expression, the Snap can be exposed to SQL injection. Please use this feature with caution
- 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 |
---|
title | 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. |
Default value: [None] | Pass through
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 ' |
|
Default Value: [None] |
---|
Query type | 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. Default Value: Auto Example: Read |
---|
Pass through
| 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. Default valueValue: Selected
|
---|
Ignore empty result
| If selected, Select this checkbox to ignore empty result; 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 you deselect this checkbox and select the Pass through property is selected checkbox, the input document will be passed through to the output view. Default valueValue: 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 valueDefault 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 |
---|
name | DDL Auto Commit |
---|
page | PostgreSQL - Execute |
---|
|
|
---|
Number of retries | Specifies Specify the maximum number of attempts to be made to receive a response. The 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. Example: 3 Default value: 0 Multiexcerpt include macro |
---|
|
---|
name | retries |
---|
page | File ReaderIf 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 greater than 0, the Snap initiates a download of 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 then attempts to download the file again from the beginning. After 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.
Note |
---|
Ensure that the local drive has sufficient free disk space to store the temporary local file. |
Default Value: 0
Example: 3
Retry interval (seconds) | Specifies Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. Default value: 1Default Value: 1 Example: 1010
|
---|
Multiexcerpt include macro |
---|
name | Snap Execution |
---|
page | SOAP Execute |
---|
|
| Multiexcerpt include macro |
---|
name | Execution_Detail_Write |
---|
page | SOAP Execute |
---|
|
|
---|