Download a file.

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	The full path of the file to download. Relative to the path provided in the URI connection property.
LocalPath	String	False	The absolute path where the file will be saved.
OutputStream	Binary	True	An instance of an output stream where file data is written to. Only used if LocalPath is not set.

Result Set Columns

Name	Type	Description
Success	Bool	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.
FileData	String	The file data encoded as BASE64. Returns a value only if LocalPath and OutputStream inputs are empty.