DESCRIBE STREAMLIT

Attention

This feature is available to accounts in AWS, Microsoft Azure, and GCP regions. AWS PrivateLink and Azure Private Link are not supported.

Describes the columns in a Streamlit object.

DESCRIBE can be abbreviated to DESC.

See also:

CREATE STREAMLIT, SHOW STREAMLITS, ALTER STREAMLIT, DROP STREAMLIT

Syntax

DESC[RIBE] STREAMLIT <name>
Copy

Required parameters

name

Specifies the identifier for the Streamlit object to describe. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

Usage notes

  • To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

Output

The command output provides information about a Streamlit object in the following columns:

| name | root_location | main_file | query_warehouse | url_id | default_packages | user_packages |
Copy

Column

Description

name

Name of the Streamlit object.

root_location

Root location of the Streamlit object’s application files.

main_file

Name of the Streamlit object’s Python file.

query_warehouse

Warehouse where queries issued by the Streamlit application are run.

url_id

Unique ID associated with the Streamlit object.

default_packages

Default Python packages for the Streamlit application.

user_packages

Python packages that the user specified in the environment.yml file. Empty if there is no environment.yml file.