CData Python Connector for SFTP

Build 23.0.8839


Download a file from the remote FTP server.


Name Type Required Description
RemoteFile String False Specify the remote file path to be downloaded. This property takes priority towards the RemotePath.
RemotePath String False Specify the remote folder path. If IncludeSubFolders is set to true, all the files and folders in this folder will be downloaded.
LocalPath String False The local path to store the downloaded files.
LocalFile String False The local name of the downloaded file. Not used when downloading remotely all the contents of a folder.
Overwrite Boolean False Whether to overwrite Local Files.


TransferMode String False The mode to be used to transfer the file.

使用できる値は次のとおりです。DEFAULT, ASCII, BINARY


IncludeSubFolders Boolean False An indicator to decide if the files inside the subfolders should be downloaded.


DownloadDepth Integer False Download depth of the folder from the Remote path.This will be used if IncludeSubFolders set to true.


ContinueOnError Boolean False An indicator to decide if the operation should continue if there is a problem with any of the files.


MaxDownloadBytes Long False If greater than 0, it will limit all downloads to at most this number of bytes.


StartByte Long False The offset in bytes relative to the beginning of the file from where to start reading


Result Set Columns

Name Type Description
FileName String This parameter sets the file name.
Success String This parameter sets whether the operation was successful or not for a specific file.
FileData String The downloaded file BASE64 encoded content. Only returned if LocalPath and FileStream is not set.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839