Versions Compared

Old Version 13

changes.mady.by.user Aparna Tayi

Saved on

compared with

New Version 14

changes.mady.by.user Aparna Tayi

Saved on

Key

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


Snap type:

Write


Description:

This Snap allows you to execute arbitrary SQL.

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.
 

Note
You can drop your database with it, so be careful.


Prerequisites:

[None]


Support and limitations:


Account: 

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

Views:


InputThis 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.
OutputThis Snap allows zero or one output view and produces documents in the 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


Required.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


Required.Specifies 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:

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 example:



Additionally, the JSON path (e.g. $myName) 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 is 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 example:



 
Known issue: 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.


Warning

With the SQL statement property set as an expression, the Snap can be exposed to SQL injection. Please use this feature with caution.


Known issue: The SQL statement will return a PGObject when returning non-standard types.


Note

Non-standard types include standard PostgreSQL extensions such as JSON or XML, types defined in third party extensions such as PostGIS, or types defined via CREATE TYPE color AS ENUM (RED, GREEN, BLUE). They can be converted to strings using CAST(x AS TEXT) where 'x' is the name of the column.

Default value: [None]


Pass through


If selected, the input document will be passed through to 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


Auto commit

Select one of the options for this property to override the state of the 'Auto commit' commit property in on the account.If 'True' or 'False' is selected, the Snap overrides the state of the 'Auto commit' property in the account. If 'Use account setting' is selected, the Snap does not override it 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.


Execute during preview


Enables you to execute the Snap during the Save operation so that the output view can produce the preview data.

Default value:  Not selected


Insert excerpt
PostgreSQL Snap Pack
PostgreSQL Snap Pack
nopaneltrue