Azure SQL - Update

On this Page

1 Settings
2 Typical Snap Configurations
3 Advanced Use Case
4 Downloads

Snap type:

Write

Description:

This Snap executes a SQL update using the input document. Keys from the document will be used as the columns to update and their values will be the updated value in the column.

While trying to access a column name that contains specific characters as supported by Azure SQL such as $, #, @ etc., such field names should be enclosed in the square brackets.

ETL Transformations & Data Flow

This Snap enables the following ETL operations/flows:

Load data in an Azure SQL table

Input & Output

Input: This Snap must have an upstream Snap that can passes documents to its output view. The documents are the data that is used in the SQL update.
Output: The Snap can have a downstream Snap. This snap writes a document to the output view summarizing each update execution.

Prerequisites:

This Snap supports SQL Server 2008 or newer.

Limitations and Known Issues:

Works in Ultra Tasks.

Configurations:

Account & Access

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

Views

Input

This Snap has exactly one document input view. The input document is used to build the update query. Below is an example for how an input document is translated to a query.

Input document:

{
    "Color": "blue",
    "ListPrice": 7.22
}

Query:

update "Database"."Table"
set [ListPrice] = 7.22, 
    [Color] = 'blue'

Output

This Snap has at most one output view and produces documents in the view. The output fields of a single view are:

message - the summary of the query outcome
status - for successful queries the number of rows updated and for failed queries the error code
original - the input document

Error

This Snap has at most one document error view and produces zero or more documents in the view.

Troubleshooting:

The section describes typical issues you may encounter while using this Snap, and instructions on how to workaround them:

Issue: A Snap with an update condition such as "Name = username" fails with error "Invalid column name 'username'.".

Solution: The issue is that the string value specified in the update condition, username, must be quoted with single quotations. The proper update condition in this example is "Name = 'username'".

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.

Schema Name

This is the name of the Azure SQL database that includes the table that will be updated. If this is not specified then the Table Name should be fully qualified with the database name. Optionally, the value can use double quotation marks as an identifier.

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

Example: SalesData

Example: "SalesData"

Table Name

Required. This is the table that will be updated. It can be specified as the table name only if the Schema Name is defined. Otherwise, it can be specified as a fully qualified name "Database"."Table". Optionally, the value can use double quotation marks as an identifier.

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

Example: ProductInfo

Example: "SalesData"."ProductInfo"

Update Condition

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.

Instead of building multiple Snaps with inter dependent DML queries, it is recommended to use the Stored Procedure or the Multi Execute Snap.
In a scenario where the downstream Snap does depends on the data processed on an Upstream Database Bulk Load Snap, use the Script Snap to add delay for the data to be available.

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

Examples:

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+ "'"

Caution

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.

Error rendering macro 'multiexcerpt-include-macro' : Page loading failed