Retrieves and downloads a file from a cloud-storage location or remote source to a specified local directory. This procedure supports automation of data retrieval and backup operations.

Procedure-Specific Information

The Path input accepts paths relative to the URI provided in the connection string.

If URI is set to: gs://test-bucket/folder2 and Path='file1.txt', the file /folder2/file1.txt will be downloaded.

The procedure is executed as below:

    EXEC DownloadFile Path='cdata.txt', LocalPath='C:/temp/test.txt'
    EXEC DownloadFile Path='/cdata.txt'

Input

Name	Type	Description
Path	String	Specifies the full file path of the file that is to be downloaded. The path is relative to the directory that is defined in the URI connection property.
LocalPath	String	Specifies the absolute local file path where the downloaded file is saved.

Result Set Columns

Name	Type	Description
Success	Bool	Indicates whether the download operation completed successfully. The Success output returns a value of 'true' when the file is downloaded without error and a value of 'false' when a failure occurs, in which case the Details output provides additional information.
Details	String	Provides detailed information about any execution failure that occurs during the download operation. The Details output returns a NULL value when the Success output is true.
FileData	String	Returns the file data that is encoded as Base64. The FileData output returns a value only when the LocalPath and OutputStream inputs are empty.