Versions Compared

Old Version 48

changes.mady.by.user Rachana Mannath

Saved on

compared with

New Version Current

changes.mady.by.user Kalpana Malladi

Saved on

Key

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

In this article

Table of Contents
minLevel1
maxLevel23
outlinefalse
styledefault
excludeOlder Versions|Additional Resources|Related Links|Related Information
typelist
printablefalse

Overview

You can use this Snap to execute arbitrary SQL query. This Snap supports SQL Server 2008 or a later version. queries. This Snap works only with single queries.

Valid JSON paths that are defined in the WHERE clause for queries/statements will be substituted with values from an incoming document. Documents are 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. 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.

Infonote

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

...

  • 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

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.

Info

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

Info

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ((blue star)): Indicates that you can add fields in the field set.

  • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

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.

Info

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.

Examples:

Image Removed

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.

Examples:

Image Removed

Multiexcerpt include macro
nameME_DB_Execute_Snaps_Scenario2
pageAzure SQL - Execute

Info

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

    • 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

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

    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

    Execute SQL statements

    Without expressions

    If you do not enable the expression toggle of the SQL statement field, then:

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

    ...

    Info

    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 a write-type query and executes in batch mode.

    With expressions 

    If you enable the expression toggle of the SQL statement field, then:

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

    Examples:

    ...

    • "EMPNO=$EMPNO and ENAME=$EMPNAME"

    • "emp='" + $emp + "'"

    • "EMPNO=" + $EMPNO + " and ENAME='" + $EMPNAME+ "'"

    Info

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

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

    Troubleshooting

    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: product, phoneno, customername, city, country. We will execute the query and retrieve customers with given name.

    ...

    We need to provide the query used to pull the data from customer1 table in SQL statement property. We will provide dynamic variable values from the upstream JSON Generator Snap. On Validation, the Snap displays the output.

    Image ModifiedImage Modified

    Downloads

    Info

    Important steps to successfully reuse Pipelines

    1. Download and import the Pipeline into SnapLogic.

    2. Configure Snap accounts as applicable.

    3. Provide Pipeline parameters as applicable.

    ...

    Expand

    Insert excerpt
    SQL Server Snap Pack
    SQL Server Snap Pack
    nameSQL_Server_SPH
    nopaneltrue

    ...

    Related Content

    ...