In this article

1 Overview
- 1.1 Snap Type
- 1.2 Prerequisites
- 1.3 Support for Ultra Pipelines
- 1.4 Limitations & Known Issues
2 Snap Views
3 Snap Settings
- 3.1 Execute SQL statements
  - 3.1.1 Without expressions
  - 3.1.2 With expressions
4 Troubleshooting
5 Example
- 5.1 Downloads
6 Snap Pack History

Overview

You can use this Snap to execute arbitrary SQL queries. This Snap works only with single queries.

You can drop your database with the execution, so we recommend you to be cautious.
You can execute stored procedures containing IN, OUT, INOUT parameters using this Snap.

Snap Type

SQL Server - Execute Snap is a Write-type Snap that executes an SQL Server statement/query.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations & Known Issues

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

Snap Views

Type	Format	Number of Views	Examples of Upstream and Downstream Snaps	Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 0
Max: 1

Mapper
Copy

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

Output

Document

Min: 0
Max: 1

JSON Formatter

This Snap allows zero or one output view and produces documents in the view.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.
Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.
Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

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.

Snap Settings

Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the field set.
Remove icon (): Indicates that you can remove fields from the field set.

Field Name	Field Type	Description

Field Name

Field Type

Description

Label*

Default Value: SQL Server - 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. 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 value	Use
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 retry attempts the Snap must make in case of network failure.

When you set the Number of retries to more than 0, the Snap generates duplicate records when the connection is not established. To prevent duplicate records, we recommend that you follow one of the following:

Set the Number of retries to 0 (default value) to prevent duplicate records from being passed downstream while executing a pipeline.
Use a Primary key to prevent records from being inserted into the database.
Use an Upsert instead of an Insert statement.

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

Default Value: Execute only
Example: Validate & Execute

Dropdown list