package upload

Uploads a Python package zip file to a Snowflake stage so it can be referenced in the imports of a procedure or function.

Syntax

snow snowpark package upload
  --file <file>
  --stage <stage>
  --overwrite
  --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

None.

Options

--file, -f PATH

Path to the file to upload.

--stage, -s TEXT

Name of the stage in which to upload the file, not including the @ symbol.

--overwrite, -o

Whether to overwrite the file if it already exists.

--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

If you specify a stage that does not exist, the command creates it automatically.

Examples

  • Upload a package to a stage:

    snow snowpark package upload -f my_package.zip -s deployments
    
    Copy
    Package my_package.zip UPLOADED to Snowflake @deployments/my_package.zip.
    
  • Upload a package to a stage that already contains a package with that name:

snow snowpark package upload -f my_package.zip -s deployments
Copy
Package already exists on stage. Consider using --overwrite to overwrite the file.