snow streamlit execute¶

Executes a streamlit in a headless mode.

Syntax¶

snow streamlit execute
  <name>
  --connection <connection>
  --host <host>
  --port <port>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --private-key-file <private_key_file>
  --token-file-path <token_file_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --enable-diag
  --diag-log-path <diag_log_path>
  --diag-allowlist-path <diag_allowlist_path>
  --format <format>
  --verbose
  --debug
  --silent
Copy

Arguments¶

name

Identifier of the Streamlit app. For example: my_streamlit.

Options¶

--connection, -c, --environment TEXT

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

--host TEXT

Host address for the connection. Overrides the value specified for the connection.

--port INTEGER

Port for the connection. Overrides the value specified for the connection.

--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-file, --private-key-path TEXT

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

--token-file-path TEXT

Path to file with an OAuth token that should be used when connecting to Snowflake.

--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. Default: False.

--mfa-passcode TEXT

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

--enable-diag

Run python connector diagnostic test. Default: False.

--diag-log-path TEXT

Diagnostic report path. Default: <temporary_directory>.

--diag-allowlist-path TEXT

Diagnostic report path to optional allowlist.

--format [TABLE|JSON]

Specifies the output format. Default: TABLE.

--verbose, -v

Displays log entries for log levels info and higher. Default: False.

--debug

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

--silent

Turns off intermediate output to console. Default: False.

--help

Displays the help text for this command.

Usage notes¶

  • The command allows a Streamlit app to be executed without user interaction, such as for batch processing or automation tasks.

  • Before executing this command, the following requirements must be met:

    • You must have a valid Snowflake connection.

    • The app must already be deployed in the Snowflake environment.

    • A valid configuration snowflake.yml file must exist with the query_warehouse and stage settings defined.

  • The application logic, such as calculations and file processing, runs as if the app were displayed, but does not render any user-visible output.

  • You must ensure that your Snowflake account, database, schema, and warehouse are properly configured before running the command.

  • If an error, such as an invalid database configuration or missing files, occurs during execution, the command displays an error message in the terminal.

Examples¶

  • Execute the my_streamlit_app app in the current process without displaying any output.

    snow streamlit execute my_streamlit_app
    
    Copy
  • Retrieve the URL for the application after execution and open it in your default web browser.

    snow streamlit get-url my_streamlit_app --open
    
    Copy