DeleteFile

Delete files in the remote SFTP Server.

Stored Procedure Specific Information

SFTP allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

EXECUTE DeleteFile RemoteFile = '/home/test/CDataTest/SPTest/TestFile.txt'

To delete all the files inside the path

EXECUTE DeleteFile RemotePath = '/home/test/'

To delete all the files in parent and subfolders

EXECUTE DeleteFile RemotePath = '/home/test', IncludeSubFolders='true'

To delete files with pattern

EXECUTE DeleteFile RemotePath = '/home/test', RemoteFile='*.txt'


Name	Type	Required	Description
RemoteFile	String	False	Specify the remote file name/path to be deleted.
RemotePath	String	False	Specify the remote folder path. when IncludeSubFolders is set to true, all the files in the subfolder will be deleted.
IncludeSubFolders	Boolean	False	An indicator to decide if the subfolders inside the path should be deleted The default value is false.


Name	Type	Description
Success	String	This parameter sets whether the operation was successful or not.
FileName	String	Deleted file.