Streamlit in Snowflake: Enable Git integration and multi-file editing for Streamlit in Snowflake apps (Pending)¶

Syntax¶

CREATE [ OR REPLACE ] STREAMLIT [ IF NOT EXISTS ] <name>
  [ { VERSION <version_alias_name> |
      VERSION (COMMENT = <version_comment>) |
      VERSION <version_alias_name> (COMMENT = <version_comment>) } ]
  [ FROM <source_location>]
  MAIN_FILE = '<path_to_main_file_in_root_directory>'
  QUERY_WAREHOUSE = <warehouse_name>
  [ COMMENT = <create_comment> ]
  [ DEFAULT_VERSION = <default_version_name_or_alias> ]
  [ TITLE = '<app_title>' ]
  [ IMPORTS = ( '<stage_path_and_file_name_to_read>' [ , ... ] ) ]
  [ EXTERNAL_ACCESS_INTEGRATIONS = ( <integration_name> [ , ... ] ) ]

Optional parameters¶

version_alias_name

A user-specified version alias name.

version_comment

A user-provided comment for this version.

source_location

A location where the source files are copied from.

create_comment

Specifies a comment for the Streamlit object. By default, there is no value.

default_version_name_or_alias

The name of the default version used.

app_title

Specifies a title for the Streamlit app to display in Snowsight.

stage_path_and_file_name_to_read

The location (stage), path, and name of the file(s) to import.

integration_name

The names of external access integrations needed in order for the Streamlit app code to access external networks.

Examples¶

To create a Streamlit app from a stage, run the CREATE STREAMLIT command, as shown in the following example:

CREATE STREAMLIT app
  FROM @streamlit_db.streamlit_schema.streamlit_stage;
  MAIN_FILE = 'streamlit_app.py'
  QUERY_WAREHOUSE = my_warehouse;

To create a Streamlit app from a Git repository, run the CREATE STREAMLIT command, as shown in the following example:

CREATE STREAMLIT app
  FROM @streamlit_db.streamlit_schema.streamlit_repo/branches/streamlit_branch/;
  MAIN_FILE = 'streamlit_app.py'
  QUERY_WAREHOUSE = my_warehouse;

Syntax¶

ALTER STREAMLIT <name> ADD VERSION [ [ IF NOT EXISTS] <version_alias_name> ]
FROM <source_location>
[ COMMENT = <add_version_comment> ]

ALTER STREAMLIT <name> ADD VERSION <version_name>
FROM { <snowgit_tag_uri> | <snowgit_commit_uri> }
[ COMMENT = <git_pull_comment> ]

ALTER STREAMLIT <name> ADD LIVE VERSION [ [IF NOT EXISTS] <version_alias_name> ]
[ FROM LAST ]
[ COMMENT = <add_version_comment> ]

ALTER STREAMLIT <name> VERSION <existing_version_name_or_alias>
SET ALIAS = <new_version_name_alias>

ALTER STREAMLIT <name> COMMIT [ VERSION <live_version_alias> ] [COMMENT = <version_comment>]

ALTER STREAMLIT <name> SET DEFAULT_VERSION = <version_name> | <version_name_alias>

ALTER STREAMLIT <name> PUSH [TO <git_branch_uri>] [ { GIT_CREDENTIALS = <snowflake_secret> | USERNAME = <git_username> password = <git_password> } NAME = <git_author_name> EMAIL = <git_author_email> ] [ COMMENT = <git_push_comment>]

ALTER STREAMLIT <name> ABORT [ VERSION  <live_version_alias> ]

ALTER STREAMLIT <name> PULL

Parameters¶

name

Name of the Streamlit app.

version_alias_name

A user-specified version alias name.

source_location

A location where the source files are copied from. Requires the OWNERSHIP privilege.

ALTER STREAMLIT name PUSH

Pushes the latest committed changes to the Git repo, using the branch stored in the base version if git_branch_uri is not specified.

If the base version is not based on a Git branch, throws an error. Requires OWNERSHIP privilege.

git-branch-uri

Target branch to push committed changes to.

git_author_name

Name of the git author to use.

git_author_email

A valid e-mail address to use as the git author’s name.

git_push_comment

A user-specified comment to include in the git push.

ALTER STREAMLIT name ABORT

Removes an existing version and deletes its files. If no version specified, it deletes live_version by default. Requires OWNERSHIP privilege.

ALTER STREAMLIT name PULL

Pulls latest changes from source to the live version of this Streamlit. Requires OWNERSHIP privilege.