snow streamlit get-url¶

Returns a URL to the specified Streamlit app

Syntax¶

snow streamlit get-url
  <name>
  --open
  --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¶

--open

Whether to open the Streamlit app in a browser. Default: False.

--connection, -c, --environment TEXT

Name of the connection, as defined in your config.toml file. 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 contain additional information. Default: False.

--silent

Turns off intermediate output to console. Default: False.

--help

Displays the help text for this command.

Usage notes¶

The streamlit get-url command returns a url link to an existing Streamlit application. You can also use the --open option to automatically open the Streamlit in a new tab in your browser.

Note the following requirements:

  • The app must already be deployed.

  • You must use the same connection that was used to deploy the app.

  • If your app is running under different database and schema than specified in the connection, you must provide them in name as a fully-qualified name, such as database.schema.name.

Examples¶

  • Get a URL for an app using the database and schema specified in the default connection and opens it in your browser:

    snow streamlit get-url my_streamlit_app --open
    Copy
    https://snowflake.com/provider-deduced-from-connection/#/streamlit-apps/DB.PUBLIC.MY_STREAMLIT_APP

  • Get a URL for an app using a fully-qualified database and schema name:

    snow streamlit get-url database.schema.my_streamlit_app
    Copy
    https://snowflake.com/provider-deduced-from-connection/#/streamlit-apps/DATABASE.SCHEMA.MY_STREAMLIT_APP
Language: English