DESCRIBE DBT PROJECT

dbtプロジェクトオブジェクト のプロパティについて説明します。

DESCRIBE は DESC に短縮できます。

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

CREATE DBT PROJECTALTER DBT PROJECTEXECUTE DBT PROJECTDROP DBT PROJECTSHOW DBT PROJECTS

構文

{ DESC | DESCRIBE } DBT PROJECT <name>
Copy

パラメーター

name

説明するdbtプロジェクトオブジェクトの識別子を指定します。

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

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

出力

コマンドの出力には、オブジェクトのプロパティとメタデータを説明する以下の列が含まれます。

説明

name

dbtプロジェクトオブジェクトの識別子(名前)。

owner

dbtプロジェクトオブジェクトの作成に使用されたロール。

comment

dbtプロジェクトオブジェクトに関連付けられたコメント。

default_target

Snowflakeを介して使用されるdbtコマンドが使用するデフォルトの実行ターゲット(たとえば prod または dev )。

external_access_integrations

dbtパッケージハブまたはGithubからリモート依存関係をプルするためにdbtプロジェクトの使用を許可される外部アクセス統合の名前。

次の列は、非推奨のパラメーターの値を示しています。

default_version

The version of the dbt project object:

  • LAST: The most recent version of the dbt project object.

  • FIRST: The oldest version of the dbt project object.

default_version_name

VERSION$num 形式のバージョン識別子。この場合、 num は正の整数です(例: VERSION$1 )。

dbtプロジェクトオブジェクトを作成し、dbtプロジェクトオブジェクトの新しいバージョンごとに1つずつインクリメントする場合、バージョン番号は 1 で始まります。

Snowflakeは、次のタスクを実行するとバージョン識別子をインクリメントします。

  • ワークスペースからdbtプロジェクトを再デプロイします( ALTER コマンドを ADD VERSION オプションを指定して実行します)。

  • ALTER DBT PROJECT コマンドを使用してプロジェクトを更新します。

  • Snow CLI snow dbt deploy コマンドを --force オプションを指定して実行します。

Snowflakeはバージョン識別子を 1 にリセットし、 CREATE DBT PROJECT コマンドを OR REPLACE オプションを指定して実行するとすべてのバージョンエイリアスを削除します。

default_version_alias

ALTER DBT PROJECT コマンドを ADD VERSION オプションで使用して、dbtプロジェクトオブジェクトの特定のバージョンに対して作成したカスタムバージョン名のエイリアス。バージョン名のエイリアスは常に、 VERSION$3 のように特定のバージョン識別子にマッピングされます。

default_version_location_uri

デフォルトバージョンの場所 URI 。これは読み取り専用です。

default_version_source_location_uri

Gitオブジェクト内にある、デフォルトバージョンのソースファイルの場所 URI 。dbtプロジェクトオブジェクトがGitオブジェクトに接続されていない場合はnullです。

dbt_snowflake_version

The Snowflake version the dbt project object is on.

アクセス制御の要件

この操作の実行に使用される ロール には、少なくとも次の 権限 が必要です。

権限

オブジェクト

MONITOR

dbtプロジェクト

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

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

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

使用上の注意

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

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

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

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

次の例では、my_dbt_project という名前のdbtプロジェクトオブジェクトについて説明します。

DESCRIBE DBT PROJECT my_dbt_project;
Copy
+----------------+--------------+------------+-------------+-----------------+----------------------+-----------------------+---------------------------------------------------------------+-------------------------------------+-----------------------+----------------+------------------------------+
|      name      |    owner     |  comment   | dbt_version | default_version | default_version_name | default_version_alias | default_version_location_uri                                  | default_version_source_location_uri | dbt_snowflake_version | default_target | external_access_integrations |
+----------------+--------------+------------+-------------+-----------------+----------------------+-----------------------+---------------------------------------------------------------+-------------------------------------+-----------------------+----------------+------------------------------+
| my_dbt_project | ACCOUNTADMIN | My comment | 1.9.4b      | LAST            | VERSION$1            | null                  | snow://dbt/MY_DB.MY_SCHEMA.my_dbt_project/versions/version$1/ | @s1                                 | null                  | dev            | null                         |
+----------------+--------------+------------+-------------+-----------------+----------------------+-----------------------+---------------------------------------------------------------+-------------------------------------+-----------------------+----------------+------------------------------+