Skip to end of banner
Go to start of banner

Azure Synapse SQL Update

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Current »

In this article

Overview

You can use this Snap to update existing records in the target tables with the specified conditions. Document keys are used as the column update, and their values are used as the updated column value.  

The updates are batched until the account's Batch size field, or the structure of the update statement changes. An update statement changes if an incoming document contains different keys than a previous document.

Snap Type

The Azure Synapse SQL Update Snap is a WRITE-type Snap that executes an SQL update.

Prerequisites

A valid database account with the required permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

When the table name contains single quote characters, the No table found error is displayed. This is because of the JDBC driver limitation.

Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 1

  • Max: 1

  • JSON Generator

The data to be updated in the table is defined by providing values upstream.

Output

Document

  • Min: 0

  • Max: 1

  • File Writer

If an output view is available, then the original document that was used to create the statement appears as output with the status of the update executed.  

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. The available options are:

  • Stop Pipeline Execution: Stops the current Pipeline execution when 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.

Snap Settings

  • 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 ValueAzure Synapse SQL - Update
Example: Azure_Synapse_SQL_Update

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.

Schema Name

Default Value: None
Example: SYS

String/Expression

Specify the database schema name. If it is not defined, then the suggestion for the Table Name retrieves all tables names of all schemas. The property is suggestible and retrieves available database schemas during suggest values.

The values can be passed using the Pipeline parameters but not the upstream parameter.

Table Name*

Default Value: None
Example: employee

String/Expression

Specify the name of the table where the update operation is to be executed.

Update Condition

Default Value: N/A
Example:

Without using expressions

  • EmpId = 12

  • email = 'you@example.com'

Using expressions

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

  • email = $email 

  • emp=$emp

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

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

Using expressions that join strings together to create SQL queries or conditions has a potential SQL injection risk and is hence unsafe. Ensure that you understand all implications and risks involved before using concatenation of strings with '=' Expression enabled. 

String/Expression

Specify the SQL WHERE clause of the update statement. You can define specific values or columns to update (Set condition) in the upstream Snap, such as Mapper Snap, and then use the WHERE clause to apply these conditions on the columns sourced from the upstream Snap. For instance, here is a sample of an Update SQL query:
UPDATE table_name
SET column1 = value1, column2 = value2,
WHERE condition;

If the Update Condition field is left blank, the condition is applied on all the records of the target table. 

In specifc scenarios where you want to use specific data from the upstream Snaps, and do not want to change that data in the Update Snap, then you need to place the data in the original structure of the input document. Therefore, we recommend that you use the format for the Update condition and input data format as shown below:

{
"valueToUpdate" : "true",
"original": {
"col1" : "KEY"
}
}

Refer to the example to understand how to use the Update Condition.

Number of Retries

Default Value0
Example: 3

Integer/Expression

Specify the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response.

Retry Interval (seconds)

Default Value1
Example: 10

Integer/Expression

Specify the time period between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. 

Snap Execution

Default Value
Example: Validate & Execute

Dropdown list

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Examples

Updating Data in an Employee Table based on a Condition

This example Pipeline demonstrates how to update data in an employee table by specifying a condition to update.

First, read the data that you want to update with a File Reader Snap:

The CSV file contains the following data:

Include a CSV Parser Snap to parse the raw data in a proper format:

The Snap parses the data from the CSV file in a proper format, ready to be updated in the database:

Include a Mapper Snap to map the input data with the target field in the database:

Based on the mapping table, it appends the first name with (QA):

Finally, include the Azure Synapse SQL Update Snap to update the values based on the specified condition:

When you execute the Snap, the Snap updates the values in the target table:

Download this Pipeline

Downloads

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts as applicable.

  3. Provide Pipeline parameters as applicable.

  File Modified
You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.
No files shared here yet.
  • Drag and drop to upload or browse for files
  • Snap Pack History

     Click here to expand...

    Release

    Snap Pack Version

    Date

    Type

    Updates

    May 2024

    437patches26597

    Latest

    Fixed an issue with the Azure Synapse SQL Select Snap that displayed an error and did not retry the connection when the serverless SQL pool was warming up.

    May 2024

    main26341

    Stable

    February 2024

    436patches25597

    -

    Upgraded the jOOQ library of the Azure Synapse SQL Snap Pack from v3.9.1 to v3.17.x.

    This upgrade is currently NOT available with the latest distribution. However, you can still consume this patch through 436patches25597. This update is scheduled to be included in the latest distribution release on April 10, 2024, and will be a part of the stable distribution with the GA release on May 8. 2024.

    Behavior change:

    The jOOQ library upgrade for Azure Synapse SQL Snap Pack, done as part of the 436patches25597, resulted in the following behavior change:

    Previously, when “null”(string) was passed from the upstream Mapper Snap for the Bigint datatype, the Azure Synapse SQL Update Snap updated it as null without displaying any error. It displayed the status as 0 and the output message as Success. Now, the Snap displays the following error in this scenario:

    Error converting value(expecting a number but you are sending String(“null”))

    If you pass null from Mapper Snap with the expression enabled, the Snap updates the null value for the BigInt datatype correctly, as earlier.

    February 2024

    main25112

    Stable

    Updated and certified against the current SnapLogic Platform release.

    November 2023

    main23721

    Stable

    Updated and certified against the current SnapLogic Platform release.

    August 2023

    main22460

    Stable

    The Azure Synapse SQL - Execute Snap now includes a new Query type field. When Auto is selected, the Snap tries to determine the query type automatically.

    May 2023

    433patches21718

    Latest

    Fixed an issue with the Azure Synapse SQL Bulkload Snap that caused a 404 error when the External Location was set to ADLS Gen2 and the Azure Folder field was not specified in the account settings.

    May 2023

    main21015

    Stable

    Upgraded with the latest SnapLogic Platform release.

    February 2023

    432patches20389

    Latest

    The Azure Synapse SQL Account and Azure Synapse SQL Active Directory Account now support the latest JDBC Driver 12.2.0.jre11 by default. You do not have to upload the JAR file in the JDBC Driver field manually.

    February 2023

    main19844

     

    Stable

    Upgraded with the latest SnapLogic Platform release.

    November 2022

    431patches19493

    Latest

    The Azure Synapse SQL - Bulk Load Snap no longer fails when loading the JDBC driver from SLDB as it now uses the uploaded JAR driver when performing all bulk load operations.

    November 2022

    431patches19410

    Stable

    Fixed the Azure SQL - Execute Snap using the Azure SQL Active Directory Account that failed with SQL operation failed errors in environments using federated authentication

    November 2022

    431patches19410

    Latest

    Fixed the Azure SQL - Execute Snap using the Azure SQL Active Directory Account that failed with SQL operation failed errors in environments using federated authentication

    November 2022

    431patches19354

    Latest

    The Azure Synapse SQL - Bulk Load Snap no longer fails with the error Invalid column value in CSV data file when the data contains the field quote character (").

    November 2022

    431patches19263

    Latest

    The Azure Synapse SQL Insert Snap no longer supports the Preserve Case Sensitivity checkbox.

    November 2022

    main18944

    Stable

    Introduced the Azure Synapse SQL Snap Pack. The Azure Synapse Analytics is service from Microsoft that helps you query data to create, update, insert, or delete data in the Azure Synapse SQL. This Snap Pack contains the following Snaps:


    Related Content

    • No labels