ALTER STREAMLIT

既存のStreamlitオブジェクトのプロパティを変更します。

こちらもご参照ください。

CREATE STREAMLIT, SHOW STREAMLITS, DESCRIBE STREAMLIT, DROP STREAMLIT

構文

ALTER STREAMLIT [ IF EXISTS ] <name> SET
  [ MAIN_FILE = '<filename>']
  [ QUERY_WAREHOUSE = <warehouse_name> ]
  [ COMMENT = '<string_literal>']
  [ TITLE = '<app_title>' ]
  [ IMPORTS = ( '<stage_path_and_file_name_to_read>' [ , ... ] ) ]
  [ EXTERNAL_ACCESS_INTEGRATIONS = ( <integration_name> [ , ... ] ) ]

ALTER STREAMLIT [ IF EXISTS ] <name> RENAME TO <new_name>

ALTER STREAMLIT <name> COMMIT

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

ALTER STREAMLIT <name> PULL

ALTER STREAMLIT <name> ADD LIVE VERSION FROM LAST
Copy

For Streamlit objects created with ROOT_LOCATION, only the following syntax is supported:

重要

ROOT_LOCATION is a legacy parameter and may be deprecated in a future release. For Streamlit apps created using ROOT_LOCATION, multi-file editing and Git integration are not supported.

ALTER STREAMLIT [ IF EXISTS ] <name> SET
  [ ROOT_LOCATION = '<stage_path_and_root_directory>' ]
  [ MAIN_FILE = '<path_to_main_file>']
  [ QUERY_WAREHOUSE = <warehouse_name> ]
  [ COMMENT = '<string_literal>']
  [ TITLE = '<app_title>' ]
  [ IMPORTS = ( '<stage_path_and_file_name_to_read>' [ , ... ] ) ]
  [ EXTERNAL_ACCESS_INTEGRATIONS = ( <integration_name> [ , ... ] ) ]

ALTER STREAMLIT [ IF EXISTS ] <name> RENAME TO <new_name>
Copy

パラメーター

name

Streamlitオブジェクトの識別子。識別子にスペースまたは特殊文字が含まれる場合は、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

SET ...

Streamlitオブジェクトに設定するプロパティを指定します。

MAIN_FILE = 'filename'

Streamlitエントリーポイントファイルのファイル名を指定します。ファイルはアプリのディレクトリのルートにあり、 .py 拡張子が含まれている必要があります。

アプリが FROM ではなく ROOT_LOCATION で作成された場合、 MAIN_FILE は ROOT_LOCATION に対する相対パスにすることができます。

QUERY_WAREHOUSE = warehouse_name

Streamlitアプリケーションが発行したクエリ SQL が実行されるウェアハウスを指定します。

COMMENT = 'string_literal'

Streamlitオブジェクトのコメントを追加するか、既存のコメントを上書きします。

TITLE = 'app_title'

Snowsight に表示するStreamlitアプリのタイトルを追加します。

IMPORTS = ( 'stage_path_and_file_name_to_read' [ , ... ] )

インポートするファイルの場所(ステージ)、パス、および名前。

EXTERNAL_ACCESS_INTEGRATIONS = ( integration_name [ , ... ] )

Streamlitアプリケーションコードが外部ネットワークにアクセスするために必要な 外部アクセス統合 の名前。

ROOT_LOCATION = 'stage_path_and_root_directory'

Specifies the root stage name and prefix containing the Streamlit Python files, media files, and environment.yml file. This parameter must point to a single directory inside a named internal stage.

RENAME TO new_name

Specifies the new identifier for the Streamlit object. The identifier must be unique for the schema where the object was created.

識別子の詳細については、 識別子の要件 をご参照ください。

COMMIT

LIVE バージョンで保留中の編集を新しい LAST バージョンにコミットします。コミット直後、 LIVE バージョンは LAST バージョンと同一になります。

PUSH

コミットされた最新の変更をGitリポジトリにプッシュします。TO git_branch_uri が指定されていない場合は、ベースバージョンに保存されているブランチを使用します。

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

TO git_branch_uri

コミットした変更を指定したブランチにプッシュします。

GIT_CREDENTIALS = snowflake_secret

リポジトリとの認証に使用する認証情報が含まれるSnowflakeシークレットを指定します。

USERNAME = git_username

Gitのユーザー名を指定します。

PASSWORD = git_password

Gitのパスワードを指定します。

NAME = git_author_name

使用するgit authorの名前を指定します。

EMAIL = git_author_email

git authorの名前として使用する有効なメールアドレスを指定します。

COMMENT = git_push_comment

git pushに含めるコメントを指定します。

ABORT

コミットされていない Snowsight で行われたすべての編集を含む、アプリの現在のライブバージョンを削除します。

PULL

最新の変更をプルします。プルする前に、現在のライブバージョンを中止する必要があります。

ADD LIVE VERSION FROM LAST

最後にコミットされたバージョンに基づいて、アプリの新しいライブバージョンを作成します。

Streamlitアプリの所有者が Snowsight でアプリを開いたときにライブバージョンが存在しない場合、このコマンドが自動的に実行されます。別のユーザーがアプリにアクセスしたときにライブバージョンが存在しない場合、エラーが返されます。

アクセス制御の要件

ロールは、オブジェクトに対して以下の 権限 を持っていなければなりません。

権限

オブジェクト

OWNERSHIP

変更するStreamlitオブジェクト

スキーマ内のオブジェクトに対して操作を実行するには、親データベースとスキーマに対する USAGE 権限が必要です。スキーマに対する 任意の権限を付与されたロールは、そのロールがスキーマを解決できることに注意してください。たとえば、スキーマに対するCREATE権限を付与されたロールは、そのスキーマにオブジェクトを作成できますが、そのスキーマに対するUSAGE*も*付与されている必要はありません。

指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。

セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。

使用上の注意

  • アプリのライブバージョンを削除した場合、ユーザーは以下のいずれかのアクションを実行するまでアプリにアクセスできません。

    • Streamlitオブジェクトに対して ALTER STREAMLIT...ADD LIVE VERSION FROM LAST を実行します。

    • アプリを所有するロールを使用して、 Snowsight でアプリにアクセスします。

  • Streamlitアプリの実行中に ALTER STREAMLIT コマンドを実行すると、アプリに変更が反映されません。

    変更をアプリに反映させる場合は、アプリをリロードするか再起動する必要があります。

  • メタデータについて:

    注意

    Snowflakeサービスを使用する場合、お客様は、個人データ(ユーザーオブジェクト向け以外)、機密データ、輸出管理データ、またはその他の規制されたデータがメタデータとして入力されていないことを確認する必要があります。詳細については、 Snowflakeのメタデータフィールド をご参照ください。