Syntax

DOWNLOAD STAGE FILE '<stage_path>' 
    [ { IN GROUP { ID '<deployment_ID>' | '<deployment_name>' } | IN { ID '<deployment_ID>' | '<deployment_name>' } } ]
    [ TO '<local_path>' ]
    [ OVERWRITE ]
    [ ENCODING '<encoding>' ]

Arguments

• stage_path: The path to the file in the Stage.

• deployment_ID, deployment_name: The ID or name of the deployment (workspace group) in which the Stage is attached.

• local_path: Specifies the download path in the local directory.

• encoding: The encoding applied to the downloaded file.

Remarks

• If the OVERWRITE clause is specified, any existing file with the same name at the specified download path is overwritten.

• The IN and IN GROUP clauses specify the ID or the name of the deployment in which the Stage is attached.

• By default, files are downloaded with the binary encoding. Specify the ENCODING clause and omit the TO clause, to view the contents of the file on the standard output.

• If the TO <local_path> clause is not specified, the file is displayed on the standard output.

Examples

• The following command displays the contents of a file in the Stage, on the standard output:

  SQL

  Copy

  DOWNLOAD STAGE FILE '/data/stats.csv' 
     IN 's2wsg'
     ENCODING 'utf8'; 

• The following command downloads the file to a specific location in the local storage:

  SQL

  Copy

  DOWNLOAD STAGE FILE '/data/stats.csv' 
     IN 's2wsg'
     TO '/tmp/stats.csv'
     OVERWRITE
     ENCODING 'utf8'; 

  If the /tmp/stats.csv file exists in the local storage, it is overwritten.