DESCRIBE STREAMLIT¶

Streamlitオブジェクト内の列を説明します。

DESCRIBE は DESC に短縮できます。

こちらもご参照ください。: CREATE STREAMLIT, SHOW STREAMLITS, ALTER STREAMLIT, DROP STREAMLIT

構文¶

DESC[RIBE] STREAMLIT <name>

Copy

必須パラメーター¶

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

アクセス制御の要件¶

ロールが以下の表にあるオブジェクトを所有していない場合、ロールはそれらのオブジェクトに対して次の権限を持つ必要があります。

権限	オブジェクト
USAGE	記述するStreamlitオブジェクト

スキーマ内のオブジェクトを操作するには、親データベースの少なくとも1つの権限と、親スキーマの少なくとも1つの権限が必要です。

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

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

使用上の注意¶

このコマンドの出力を後処理するには、パイプ演算子（->>）または RESULT_SCAN 関数。どちらのコンストラクトも、出力をクエリできる結果セットとして扱います。

たとえば、パイプ演算子または RESULT_SCAN 関数を使用して、 SHOW コマンド出力から特定の列を選択したり、行をフィルター処理したりできます。

出力列を参照する場合は、列名に二重引用符で囲まれた識別子を使用します。たとえば、出力列 type を選択するには、 SELECT "type" を指定します。

SHOW コマンドの出力列名は小文字のため、二重引用符で囲まれた識別子を使用する必要があります。二重引用符により、 SELECT リストまたは WHERE 句内の列名が、スキャンされた SHOW コマンド出力内の列名と一致することが保証されます。

出力¶

コマンド出力は、Streamlitオブジェクトに関する情報を以下の列で提供します。

列	説明
`title`	Snowsightに表示されるStreamlitオブジェクトのタイトル。
`main_file`	Streamlitアプリのエントリポイントファイルの名前。
`query_warehouse`	Streamlitアプリが発行したクエリが実行されるウェアハウス。
`runtime_name`	`SYSTEM$ST_WAREHOUSE_RUNTIME_PY3_11` または `SYSTEM$ST_CONTAINER_RUNTIME_PY3_11` のような、Streamlitアプリのランタイム環境。
`compute_pool`	Streamlitアプリを実行するコンピューティングプール。これはコンテナランタイムにのみ使用され、ウェアハウスランタイムでは無視されます。
`url_id`	Streamlitオブジェクトに関連付けられた一意の ID。
`default_packages`	StreamlitアプリケーションのデフォルトPythonパッケージ。
`user_packages`	ユーザーが `environment.yml` ファイルで指定したPythonパッケージ。`environment.yml` ファイルがない場合は空で、コンテナランタイムには適用されません。
`import_urls`	Streamlitアプリがインポートする URLs のリスト。これはコンテナランタイムには適用されません。
`external_access_integrations`	Streamlitオブジェクトに関連する外部アクセス統合のリスト。
`external_access_secrets`	Streamlitオブジェクトに関連する外部アクセスシークレットのリスト。
`name`	Streamlitオブジェクトのスキーマ内での一意の名前。
`comment`	Streamlitオブジェクトに関連するコメント。
`default_version`	ライブバージョンがない場合に使用するStreamlitオブジェクトのデフォルトバージョン。アプリにまだライブバージョンがなく、所有者がSnowsightでアプリを開いた場合、このバージョンがライブバージョンにコピーされます。
`default_version_name`	Streamlitオブジェクトのファイルシステム内のデフォルトバージョンディレクトリ名。
`default_version_alias`	サポート対象外で、常にnullです。
`default_version_location_uri`	デフォルトバージョンのアプリファイルの場所 URI 。これは読み取り専用です。
`default_version_source_location_uri`	Gitオブジェクト内にある、デフォルトバージョンのソースファイルの場所 URI 。StreamlitオブジェクトがGitオブジェクトに接続されていない場合はnullです。
`default_version_git_commit_hash`	StreamlitオブジェクトのデフォルトバージョンのGitコミットハッシュ。StreamlitオブジェクトがGitオブジェクトに接続されていない場合はnullです。
`last_version_name`	Streamlitオブジェクトのファイルシステム内の最終バージョンディレクトリ名。
`last_version_alias`	サポート対象外で、常にnullです。
`last_version_location_uri`	最終バージョンのアプリファイルの場所 URI 。これは読み取り専用です。
`last_version_source_location_uri`	Gitオブジェクト内にある、最終バージョンのソースファイルの場所 URI 。StreamlitオブジェクトがGitオブジェクトに接続されていない場合はnullです。
`last_version_git_commit_hash`	Streamlitオブジェクトの最終バージョンのGitコミットハッシュ。StreamlitオブジェクトがGitオブジェクトに接続されていない場合はnullです。
`live_version_location_uri`	Streamlitオブジェクトのライブバージョンの場所 URI 。この場所は読み書き可能です。Snowsightにおける編集はこの場所に保存されます。この場所にファイルをコピーすることで、ライブアプリをリモートで更新できます。

ROOT_LOCATION パラメーターを使用して作成されたStreamlitオブジェクトの場合、コマンド出力は以下の列の情報を提供します。

列	説明
`name`	Streamlitオブジェクトのスキーマ内での一意の名前。
`title`	Snowsightに表示されるStramlitオブジェクトのタイトル。
`root_location`	Streamlitオブジェクトのファイルの場所。
`main_file`	ルートの場所を基準とした、Streamlitアプリのエントリポイントファイルへのパス。
`query_warehouse`	Streamlitアプリが発行したクエリが実行されるウェアハウス。
`url_id`	Streamlitオブジェクトに関連付けられた一意の ID。
`default_packages`	StreamlitアプリのデフォルトPythonパッケージ。
`user_packages`	ユーザーが `environment.yml` ファイルで指定したPythonパッケージ。これは、 `environment.yml` ファイルがない場合は空になります。
`import_urls`	Streamlitアプリがインポートする URLs のリスト。
`external_access_integrations`	Streamlitオブジェクトに関連する外部アクセス統合のリスト。
`external_access_secrets`	Streamlitオブジェクトに関連する外部アクセスシークレットのリスト。