dbtプロジェクトオブジェクトのデプロイ¶

dbt Projects on Snowflake で、dbtプロジェクトオブジェクトのデプロイとは、dbtプロジェクトコードをSnowflakeにコピーして、オブジェクトを作成したり、新しいバージョンで更新したりすることを意味します。これを実行するには、 Snowsight 、CREATE DBT PROJECT または ALTER DBT PROJECT SQL コマンド、Snowflake CLI の snow dbt deploy コマンドを使用します。

Snowsight を使用してdbtプロジェクトオブジェクトをデプロイする¶

Snowsight でのdbtプロジェクトオブジェクトのデプロイでは、ワークスペース内のdbtコードを取得して、新規のdbtプロジェクトを作成するか、既存のdbtプロジェクトを更新します。

Snowsight でdbtプロジェクトオブジェクトをデプロイするには、 dbt depsコマンドを実行してから、次のステップを完了します。

Snowsight にサインインします。
ナビゲーションメニューで Projects » Workspaces を選択します。
Workspaces メニューで、dbtプロジェクトを含むワークスペースを選択します。
dbtファイルが所定の場所にあることを確認します。

機能することを確認するため、次のように dbt compile 、 dbt run 、または dbt build コマンドを実行します。
1. ワークスペースエディターの下で Output タブを開くと、ワークスペースからdbtコマンドを実行した後に標準出力が表示されます。
2. ワークスペースエディターの上にあるメニューバーで、正しい Project と Profile が選択されていることを確認します。
3. コマンドリストから、 dbt compile 、 dbt run 、 dbt build のいずれかを選択してから、実行ボタンを選択します。このステップでは、プロジェクトを解析します。
ワークスペースの右上から、 Connect を選択してから、次のいずれかを選択します。
- Deploy dbt project で新しいdbtプロジェクトに接続します。最初のデプロイ時、これによりスキーマレベルのdbtプロジェクトオブジェクトが作成されます。
- :Existing dbt deployment で既存のdbtプロジェクトに接続します。デプロイすると、既存のdbtプロジェクトオブジェクトに新しいバージョンが追加されます（ ALTER DBT PROJECT … ADD VERSION FROM 'snow://workspace/…/versions/last' と同等）。
Deploy dbt project ポップアップウィンドウで、次を選択します。
- Select location の下で、データベースとスキーマを選択します。
- Select or Create dbt projecr の下で、 Create dbt project を選択します。
- 名前と説明を入力します。
- オプションで、デフォルトのターゲットを入力して、コンパイルとその後の実行にどのプロファイルを使用するかを選択します（たとえば、prod）。dbtプロジェクト実行のターゲットは、変わらず、ARGS の --target でオーバーライドできます。
- オプションで、Run dbt deps を選択してから、デプロイ中に自動的に dbt deps を実行する外部アクセス統合を選択します。
Deploy を選択します。

その Output タブには、Snowflakeで実行されるコマンドが表示されます。これは次の例と同様です。
```
CREATE DBT PROJECT mydb.my_dbt_projects_schema.my_dbt_project
  FROM 'snow://workspace/mydb.my_dbt_projects_schema.sales_model/versions/version$2'
  EXTERNAL_ACCESS_INTEGRATIONS = ();
```
Copy
```
my_dbt_project successfully created.
```
Connect メニューには、作成したdbtプロジェクトオブジェクトの名前と、次のオプションが表示されるようになります。
- Redeploy dbt project:ALTER を使用して、プロジェクトの現在のワークスペースバージョンでdbtプロジェクトオブジェクトを更新します。これによりdbtプロジェクトオブジェクトのバージョンが1つずつ増加します。詳細については、 dbtプロジェクトオブジェクトとファイルのバージョン管理をご参照ください。
- Disconnect:dbtプロジェクトオブジェクトからワークスペースを切断しますが、dbtプロジェクトオブジェクトは削除しません。
- Edit project:dbtプロジェクトオブジェクトのコメント、デフォルトターゲット、外部アクセス統合を更新します。
- View project:オブジェクトエクスプローラーでdbtプロジェクトオブジェクトを開きます。そこにはdbtプロジェクトオブジェクトの CREATE DBT PROJECT コマンドとプロジェクトの実行履歴が表示されます。
- Create schedule:スケジュール上でdbtプロジェクトオブジェクトを実行するタスクを作成するためのオプションを提供します。詳細については、 dbtプロジェクトの実行をスケジュールするタスクを作成するをご参照ください。
- View schedules:dbtプロジェクトオブジェクトを実行するスケジュール（タスク）のリストを開きます。オブジェクトエクスプローラーでタスクの詳細を表示するオプションがあります。
オプションで、たとえば次のように、ワークシートで SHOW DBT PROJECTS コマンドを実行してdbtプロジェクトが存在することを確認します。
```
SHOW DBT PROJECTS IN DATABASE mydb;
```
Copy

SQL コマンドを使用してdbtプロジェクトオブジェクトをデプロイする¶

CREATE DBT PROJECT コマンドと ALTER DBT PROJECT コマンドは、それぞれ、ステートメントの FROM 句で指定されたファイルをコピーして、dbtプロジェクトオブジェクトを作成するか、新しいバージョンを追加します。

CREATE DBT PROJECT コマンドは、以下に示すように、単一の初期バージョンで新しいオブジェクトを作成します（例: VERSION$1）。

CREATE DBT PROJECT mydb.my_dbt_projects_schema.my_dbt_project
  FROM '@sales_db.integrations_schema.sales_dbt_git_stage/branches/main'
  DEFAULT_TARGET = 'prod'
  EXTERNAL_ACCESS_INTEGRATIONS = my_dbt_ext_access
  COMMENT = 'Generates sales data models.';

Copy

ALTER DBT PROJECT コマンドは、一意のインクリメントされたバージョン番号で、既存のオブジェクト内に新しいバージョンを作成します（例: VERSION$2 、 VERSION$3 など）。

-- Update the Git repository object to fetch the latest code
ALTER GIT REPOSITORY sales_db.integrations_schema.sales_dbt_git_stage FETCH;

-- Add a new version to the dbt project object based on the updated Git repository object
ALTER DBT PROJECT mydb.my_dbt_projects_schema.my_dbt_project
  ADD VERSION
  FROM '@sales_db.integrations_schema.sales_dbt_git_stage/branches/main/sales_dbt_project';

Copy

Snowflake CLI を使用してdbtプロジェクトオブジェクトをデプロイする¶

snow dbt deploy コマンドは、仮ステージにローカルファイルをアップロードし、新しいdbtプロジェクトオブジェクトを作成し、新しいバージョンを作成して更新するか、完全に再作成します。有効なdbtプロジェクトには、2つのファイルが含まれている必要があります。

dbt_project.yml:使用するプロファイルを指定する標準のdbt構成ファイル。
profiles.yml:dbt_project.yml で参照されるdbt接続プロファイル定義。 profiles.yaml は、データベース、ロール、スキーマ、およびタイプを定義する必要があります。
- デフォルトでは、 dbt Projects on Snowflake は、dbt環境またはプロファイルから指定されたターゲットスキーマ（target.schema）を使用します。dbt Coreの動作とは異なり、 profiles.yml ファイルで指定されたターゲットスキーマは、正常にコンパイルまたは実行するためには、dbtプロジェクトを作成する前に存在している必要があります。
```
<profile_name>:
target: dev
outputs:
  dev:
    database: <database_name>
    role: <role_name>
    schema: <schema_name>
    type: snowflake
```
Copy

次の例は、 snow dbt deploy コマンドの使用方法を説明しています。

:codenowrap:`jaffle_shop`という名前のdbtプロジェクトオブジェクトをデプロイします。
```
snow dbt deploy jaffle_shop
```
Copy
指定されたディレクトリから jaffle_shop という名前のプロジェクトをデプロイし、dbtプロジェクトオブジェクトがすでに存在するかどうかに応じて、新しいバージョンを作成するか追加します。
```
snow dbt deploy jaffle_shop --source /path/to/dbt/directory --profiles-dir ~/.dbt/ --force
```
Copy
カスタムプロファイルディレクトリを使用し、外部アクセス統合を有効にして、指定されたディレクトリから jaffle_shop という名前のプロジェクトをデプロイします。
```
snow dbt deploy jaffle_shop --source /path/to/dbt/directory
--profiles-dir ~/.dbt/ --default-target dev
--external-access-integration dbthub-integration
--external-access-integration github-integration
--force
```
Copy

ソースファイルの場所¶

dbtプロジェクトのソースファイルは、次のいずれかの場所にあります。

Gitリポジトリステージ。たとえば:

'@my_db.my_schema.my_git_repository_stage/branches/my_branch/path/to/dbt_project_or_projects_parent'

SnowflakeでGitリポジトリオブジェクトを作成し、Gitリポジトリを |sf-dbt|のワークスペースに接続する方法については、 label-dbt_create_git_integrated_workspace`をご参照ください。ワークスペースを使用せずにGitリポジトリオブジェクトとステージを作成および管理する方法の詳細については、 :doc:/developer-guide/git/git-overview` および :doc:`/sql-reference/sql/create-git-repository`をご参照ください。

既存のdbtプロジェクトステージ。例えば:

'snow://dbt/my_db.my_schema.my_existing_dbt_project_object/versions/last'

バージョン指定子は必須で、last``（前の例で示したように）、 ``first、または``version$<num>``の形式で既存バージョンの指定子とすることができます。詳細については、 dbtプロジェクトオブジェクトとファイルのバージョン管理をご参照ください。

内部の名前付きステージ。たとえば:

'@my_db.my_schema.my_internal_named_stage/path/to/dbt_projects_or_projects_parent'

内部ユーザーステージとテーブルステージはサポートされていません。

Snowflake上のdbtのワークスペース。たとえば:

'snow://workspace/user$.public."my_workspace_name"/versions/live/path/to/dbt_projects_or_projects_parent'

ワークスペース名は大文字と小文字が区別され、特殊文字を含めることができるため、ワークスペース名を二重引用符で囲むことをお勧めします。

バージョン指定子は必須で、last、first、live、または``version$<num>``の形式で既存バージョンの指定子とすることができます。詳細については、 dbtプロジェクトオブジェクトとファイルのバージョン管理をご参照ください。