SHOW STREAMLITS

Attention

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

Lists the Streamlit objects for which you have access privileges.

See also:

CREATE STREAMLIT, DESCRIBE STREAMLIT, ALTER STREAMLIT, DROP STREAMLIT

Syntax

SHOW [ TERSE ] STREAMLITS [ LIKE '<pattern>' ]
                          [ IN
                                {
                                  ACCOUNT                   |

                                  DATABASE                  |
                                  DATABASE <db_name>        |

                                  SCHEMA
                                  SCHEMA <schema_name>      |
                                  <schema_name>             |
                                }
                          ]
                          [ LIMIT <rows> [ FROM '<name_string>' ]
Copy

Parameters

TERSE

Returns only a subset of the output columns:

  • created_on

  • name

  • kind

    The kind column value is always Streamlit.

  • database_name

  • schema_name

  • url_id

LIKE 'pattern'

Optionally filters the command output by object name. The filter uses case-insensitive pattern matching, with support for SQL wildcard characters (% and _).

For example, the following patterns return the same results:

... LIKE '%testing%' ...
... LIKE '%TESTING%' ...

. Default: No value (no filtering is applied to the output).

[ IN ... ]

Optionally specifies the scope of the command. Specify one of the following:

ACCOUNT

Returns records for the entire account.

DATABASE, . DATABASE db_name

Returns records for the current database in use or for a specified database (db_name).

If you specify DATABASE without db_name and no database is in use, the keyword has no effect on the output.

SCHEMA, . SCHEMA schema_name, . schema_name

Returns records for the current schema in use or a specified schema (schema_name).

SCHEMA is optional if a database is in use or if you specify the fully qualified schema_name (for example, db.schema).

If no database is in use, specifying SCHEMA has no effect on the output.

Default: Depends on whether the session currently has a database in use:

  • Database: DATABASE is the default (that is, the command returns the objects you have privileges to view in the database).

  • No database: ACCOUNT is the default (that is, the command returns the objects you have privileges to view in your account).

LIMIT rows [ FROM 'name_string' ]

Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. The actual number of rows returned might be less than the specified limit. For example, the number of existing objects is less than the specified limit.

The optional FROM 'name_string' subclause effectively serves as a “cursor” for the results. This enables fetching the specified number of rows following the first row whose object name matches the specified string:

  • The string must be enclosed in single quotes and is case-sensitive.

  • The string does not have to include the full object name; partial names are supported.

Default: No value (no limit is applied to the output)

Note

For SHOW commands that support both the FROM 'name_string' and STARTS WITH 'name_string' clauses, you can combine both of these clauses in the same statement. However, both conditions must be met or they cancel out each other and no results are returned.

In addition, objects are returned in lexicographic order by name, so FROM 'name_string' only returns rows with a higher lexicographic value than the rows returned by STARTS WITH 'name_string'.

For example:

  • ... STARTS WITH 'A' LIMIT ... FROM 'B' would return no results.

  • ... STARTS WITH 'B' LIMIT ... FROM 'A' would return no results.

  • ... STARTS WITH 'A' LIMIT ... FROM 'AB' would return results (if any rows match the input strings).

Usage notes

  • You can use this command to list Streamlit objects for the current/specified database or schema, or across your entire account.

  • The command does not list Streamlit objects that have been dropped.

  • The command does not require a running warehouse to run.

Output

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

Column

Description

created_on

Date and time when the Streamlit object was created.

name

Name of the Streamlit object.

database_name

Database in which the Streamlit object is stored.

schema_name

Schema in which the Streamlit object is stored.

owner

Role that owns the Streamlit object.

comment

Comment for 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.

owner_role_type

The type of role that owns the object, either ROLE or DATABASE_ROLE. . If a Snowflake Native App owns the object, the value is APPLICATION. . Snowflake returns NULL if you delete the object because a deleted object does not have an owner role.