Versions Compared

Old Version 30

changes.mady.by.user Cindy Hall

Saved on

compared with

New Version Current

changes.mady.by.user Rachana Mannath

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Snap type

Write

Description

This Snap enables you to execute SQL statements in a Vertica database. Tables can be created and dropped with this Snap. SELECT queries can also be executed. This Snap works only with single queries.

Note

You can drop your database with it, so be cautious.


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. Additionally, the original document is written if there are no results from the query.

Note
The Vertica Execute Snap is for simple DML (SELECT, INSERT, UPDATE, DELETE) type statements.


Prerequisites

N/A

Support and limitations

Works in Ultra Task Pipelines.

Behavior Change
Multiexcerpt include macro
nameBehavior change in Database Execute Snaps
pageAzure SQL - Execute
Account

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Vertica Accounts for information on setting up this type of account.

Views


InputThis Snap has at most one input view. If the input view is defined, then the WHERE clause can substitute incoming values for a given expression.
OutputThis Snap has at most one output view.
Error

This Snap has at most one 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*


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*


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 to successfully execute your SQL statements:

Info
titleScenarios 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.

Examples:



Multiexcerpt include macro
nameME_DB_Execute_Snaps_Scenario1
pageAzure 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.

Examples:

Multiexcerpt include macro
nameME_DB_Execute_Snaps_Scenario2
pageAzure SQL - Execute


Info

We recommend you to add a single query in the SQL Statement field.

Known issue: When the SQL statement property is an expression, the pipeline parameters are shown in the suggest, but not the input schema.

Panel
titleSnap History
  • 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.


Warning
titleSingle 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 valueUse
Has no single quotes
Schaum Series
'Schaum Series'
Contains single quotes
O'Reilly's Publication
'O''Reilly''s Publication'



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 output view under the key 'original'. This property applies only to the Execute Snaps with SELECT statement.

Default Value: Selected

Ignore empty result


If selected, 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 the Pass through property is selected, the input document will be passed through to the output view.

Default Value: Not selected

Number of retries

The maximum number of times that the process must be retried before displaying an error.

Default Value: 0
Example: 2

Retry interval (seconds)

Specify the maximum resting time in seconds between subsequent retries.

Default Value: 1
Example: 2

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 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
nameDDL Auto Commit
pagePostgreSQL - Execute

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute


Insert excerpt
Vertica Snap Pack
Vertica Snap Pack
nopaneltrue