object stage copy

Copies all files from target path to target directory. This works for both uploading to and downloading files from the stage.

Syntax

snow object stage copy
  <source_path>
  <destination_path>
  --overwrite
  --parallel <parallel>
  --connection <connection>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --private-key-path <private_key_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --format <format>
  --verbose
  --debug
  --silent
Copy

Arguments

source_path SOURCE_PATH

Source path for copy operation. Can be either stage path or local.

destination_path DESTINATION_PATH

Target directory for copy operation. Should be stage if source is local or local if source is stage.

Options

--overwrite

Overwrites existing files in the target path.

--parallel INTEGER

Number of parallel threads to use when uploading files.

--connection, -c, --environment TEXT

Name of the connection, as defined in your config.toml. Default: default.

--account, --accountname TEXT

Name assigned to your Snowflake account. Overrides the value specified for the connection.

--user, --username TEXT

Username to connect to Snowflake. Overrides the value specified for the connection.

--password TEXT

Snowflake password. Overrides the value specified for the connection.

--authenticator TEXT

Snowflake authenticator. Overrides the value specified for the connection.

--private-key-path TEXT

Snowflake private key path. Overrides the value specified for the connection.

--database, --dbname TEXT

Database to use. Overrides the value specified for the connection.

--schema, --schemaname TEXT

Database schema to use. Overrides the value specified for the connection.

--role, --rolename TEXT

Role to use. Overrides the value specified for the connection.

--warehouse TEXT

Warehouse to use. Overrides the value specified for the connection.

--temporary-connection, -x

Uses connection defined with command line parameters, instead of one defined in config.

--mfa-passcode TEXT

Token to use for multi-factor authentication (MFA).

--format [TABLE|JSON]

Specifies the output format.

--verbose, -v

Displays log entries for log levels info and higher.

--debug

Displays log entries for log levels debug and higher; debug logs contains additional information.

--silent

Turns off intermediate output to console.

--help

Displays the help text for this command.

Usage notes

One of SOURCE_PATH or DESTINATION_PATH must be a local directory, while the other should be a directory in the Snowflake stage. The stage path must start with “@”. For example:

  • snow object stage copy @my_stage dir/ - copies files from my_stage stage to the local dir directory.

  • snow object stage copy dir/ @my_stage - copies files from the local dir directory to my_stage.

Examples

To copy files from the local machine to a stage, use a command similar to the following:

snow object stage copy local_example_app @example_app_stage/app
Copy
put file:///.../local_example_app/* @example_app_stage/app4 auto_compress=false parallel=4 overwrite=False
+--------------------------------------------------------------------------------------
| source           | target           | source_size | target_size | source_compression...
|------------------+------------------+-------------+-------------+--------------------
| environment.yml  | environment.yml  | 62          | 0           | NONE             ...
| snowflake.yml    | snowflake.yml    | 252         | 0           | NONE             ...
| streamlit_app.py | streamlit_app.py | 109         | 0           | NONE             ...
+--------------------------------------------------------------------------------------

To download files from a stage to a local directory, use a command similar to the following:

$ snow object stage copy @my_stage my_dir/
Copy