Downloads a JSON file from a local directory or remote storage location to the specified path.

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	Accepts Output Streams	Description
Path	String	False	Specifies the full path of the JSON file to be downloaded. The path is relative to the directory defined in the Uniform Resource Identifier (URI) connection property.
LocalPath	String	False	Specifies the absolute local path where the downloaded file will be saved.
OutputStream	Binary	True	Provides an output stream used to write the downloaded file data. This input is used only when LocalPath is not specified.

Result Set Columns

Name	Type	Description
Success	Bool	Indicates whether the file download operation completed successfully. If the value is 'false', the Details output parameter provides additional details.
Details	String	Provides diagnostic information if the operation fails. When the download succeeds, this field is returned as NULL.
FileData	String	Returns the file content encoded in base64. This output is returned only when both LocalPath and OutputStream inputs are empty.