SQL Server - Delete
In this article
Overview
You can use this Snap to execute a SQL delete with the given properties. This Snap supports SQL Server 2008 and higher versions.
Snap Type
The SQL Server - Delete Snap is a Write-type Snap that executes an SQL Server delete.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations & Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
| JSON Generator | This Snap allows exactly one input view. |
Output | Document |
| JSON Formatter | This Snap has at most one output view. If an output view is available, then the original document that was used to create the statement will be output with the status of the delete executed. The Snap will output one document for each execution of the Snap with data about the number of documents deleted, hence any document processing Snap can be used downstream. |
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 whether 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: Snowflake - Delete | String | Specify a unique name for the Snap. |
Schema Name
Default Value: N/A | String/Expression
| Specify the database schema name. In case it is not defined, then the suggestion for the Table Name will retrieve all tables names of all schemas. The property is suggestable and will retrieve available database schemas during suggest values. The values can be passed using the pipeline parameters but not the upstream parameter. |
Table Name*
Default Value: N/A | String/Expression
| Specify the table name to execute the delete on. The values can be passed using the pipeline parameters but not the upstream parameter. |
Delete condition (deletes all records from table if left blank)
Default Value: N/A
| String/Expression | Specify the SQL WHERE clause of the delete statement. The delete condition may also be passed via an upstream Snap or through the pipeline parameters. Examples: Without using expressions
Using expressions
|
Number of retries
Default value: 0 | 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 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 three modes in which the Snap executes. Available options are:
|
Example
This example pipeline demonstrates how to delete records from table 'customer_one'.
The Delete condition specifies the condition to identify the records to be deleted.
On validation of the pipeline, all the user records with the customer name 'John' are deleted from the table.