In this article
Overview
You can use this Snap to delete records from the target tables.
Snap Type
The Azure Synapse SQL Delete Snap is a WRITE-type Snap.
Prerequisites
Valid Azure Synapse SQL Account.
Access to Azure Synapse SQL and the required permissions to delete.
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 |
|
| The records to be deleted. |
Output | Document |
| NA | The original document with the status of the delete operation. |
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:
Learn more about Error handling in Pipelines. | |||
Snap Settings
Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (
): Indicates a list that is dynamically populated based on the configuration.Expression icon (
): Indicates 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 |
|---|---|---|
Label* Default Value: Azure Synapse SQL - Delete | String | Specify a unique name for the Snap. |
Schema Name
Default Value: N/A | String/Expression/Suggestion | Specify the database schema name from which you want to delete the record. If you do not specify the schema name, then the suggestion for the Table Name fetches all tables names of all schemas. |
Table Name
Default Value: N/A | String/Expression/Suggestion | Specify the table name to execute the delete on. |
Delete Condition (Truncates Table if empty) Default Value: N/A Without using expressions
Using expressions
| String/Expression | Specify the SQL WHERE clause of the delete statement. You can specify the delete from an upstream Snap or through the Pipeline parameters. Specify a valid WHERE clause for the delete condition. If you leave this field blank, the Snap truncates the table. Caution Using expressions that join strings together to create SQL queries or conditions has a potential SQL injection risk and hence is unsafe. Ensure that you understand all implications and risks involved before using concatenation of strings with '=' Expression enabled. |
Number of Retries Default Value: 0 | Integer/Expression | Specify the maximum number of retry attempts to make to receive a response. The request is terminated if the attempts do not result in a response. |
Retry interval (Seconds) Default Value: 1 | Integer/Expression | Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. |
Snap Execution Default Value: Execute only | Dropdown list | Select one of the following three modes in which the Snap executes:
|
Example
Deleting Employee Table from the Azure Synapse SQL Database
This example Pipeline demonstrates how to delete employee records from the employee table by specifying a delete condition.
Step 1: Configure the File Reader Snap to read the EmployeeData.csv file from the SL database.
On validation, the Snap generates output in binary format.
Step 2: Configure the CSV Parser Snap to parse binary data and generate output in document format.
Step 3: Configure the Mapper Snap to extract only the Employee ID row from the incoming data.
On validation, the Snap generates EMP_ID of all the employees in the output.
Step 4: Configure the Azure Synapse SQL Delete Snap to delete employee records from “dbo”.”Employee1” table. Also, specify the Delete Condition to prevent the deletion of rows other than the EMP_ID row from the table.
On validating the Pipeline, the Snap generates output with the status of the deleted records.
Downloads
Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.
