In this article
You can use this Snap to delete records from the target tables.
The Azure Synapse SQL Delete Snap is a WRITE-type Snap.
Valid Azure Synapse SQL Account.
Access to Azure Synapse SQL and the required permissions to delete.
Works in Ultra Pipelines.
None.
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. |
|
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 (deletes all records from table if left blank) 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 deletes all the records from the table. Specify a valid WHERE clause for the delete condition. If you leave this field blank, the Snap deletes all the records from the table.
| |
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:
|
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.
|