Versions Compared

Key

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

In this article

...

Field Name

Field Type

Description

Label*

Default ValueSQL Server - Execute
ExampleExecute 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. Learn more about how to execute SQL statements.

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

  • You cannot use pipeline parameters within your SQL statement. If you need to use parameters, connect a Mapper Snap before the SQL Snap and provide the values.

  • Avoid using non-standard words, such as GO in SQL statements, as GO is not a recognized keyword in SQL Server.

  • Table name and column names must not be provided as bind parameters. Only values can be provided as bind parameters.

  • Valid JSON paths that are defined in the WHERE clause for queries/statements will be substituted with values from an incoming document.

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

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 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.
If you deselect this checkbox and the Pass through checkbox is selected, 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 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.

  • If 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.

Ensure that the local drive has sufficient free disk space to store the temporary local file.

Retry interval (seconds)

Default Value: 1
Example: 10

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
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: TrueFalse, 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 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

Default Value: Execute only
Example: Validate & Execute

Dropdown list

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

...

Error

Reason

Resolution

Failure: Batch operation failed. Error code: 102

Incorrect syntax near 'GO'.

Rewrite the query without ‘GO’ and run it.

Example

In this example, we have a table named "customer1" that stores user details. It has the columns: productphonenocustomernamecitycountry. We will execute the query and retrieve customers with given name.

...