JDBC Driver for SFTP

Build 24.0.9062

Download

Download a file from the remote FTP server.

Input

Name Type Required Accepts Output Streams Description
RemoteFile String False False Specify the remote file path to be downloaded. This property takes priority towards the RemotePath.
RemotePath String False 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 False The local path to store the downloaded files.
LocalFile String False False The local name of the downloaded file. Not used when downloading remotely all the contents of a folder.
Overwrite Boolean False False Whether to overwrite Local Files.

デフォルト値はtrueです。

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

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

デフォルト値はDEFAULTです。

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

デフォルト値はfalseです。

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

デフォルト値は0です。

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

デフォルト値はfalseです。

FileStream String False True OutputStream to write the downloaded document. Only returned if LocalPath is not set.
MaxDownloadBytes Long False False If greater than 0, it will limit all downloads to at most this number of bytes.

デフォルト値は0です。

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

デフォルト値は0です。

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 24.0.9062