In this article
...
The File Delete Snap is a WRITE-type Snap.
Prerequisites
...
Multiexcerpt include macro | ||||||||
---|---|---|---|---|---|---|---|---|
|
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
Limitations
None.
Known Issues
This Snap Pack does not natively support SHA1-based algorithms to connect to SFTP endpoints. With the August 2023 GA release, you can now leverage the properties specified in the Configuration settings for Snaps to add support for ones that are disabled on your Snaplex.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description | ||
---|---|---|---|---|---|---|
Input | Document |
|
| The Snap expects to find values for the JSON paths used in the File property, if any. | ||
Output | Document |
|
| The file name and the delete status are written to the output view. The following example shows the output document map data:
| ||
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:
Learn more about Error handling in Pipelines. |
Snap Settings
Info |
---|
|
Field Name | Field Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Label* Default Value: File Delete | String | Specify a unique name for the Snap. | |||||||||||||||
File* Default value: [None] SLDB:
VPC:
| String/Expression | Specify the URL for the file to be deleted. It might start with a file protocol. The supported file protocols are SLDB, S3, FTP, SFTP, FTPS, WASB, WASBS, GS, and SMB protocols. This Snap supports S3 Virtual Private Cloud (VPC) endpoint.
| |||||||||||||||
File delete action | Dropdown list | Specify the action that the Snap must take when the target file is not found during a file delete attempt. Select from the following options:
| |||||||||||||||
Validate deletion Default value: Deselected | Checkbox | Select this check box to enable the Snap to check if the deleted file still exists. | |||||||||||||||
Number of retries Default value: 0 | Integer/Expression | Specify the maximum number of retry attempts in case of a network failure.
Minimum value: 0 | |||||||||||||||
Retry interval (seconds) Default value: 1 | Integer/Expression | Specify the minimum number of seconds for which the Snap must wait before attempting recovery from a network failure. Minimum value: 1 | |||||||||||||||
Advanced properties | Use this field set to define additional advanced properties. | ||||||||||||||||
| Dropdown list |
| |||||||||||||||
Values | String/Expression | Specify the value for SAS URI. | |||||||||||||||
Snap Execution Default Value: Execute only | Dropdown list |
|
Examples
Deleting a File from Your SnapLogic Database
...