本記事では、dbtで使うコマンドを紹介します。
dbt Core, dbt Cloud IDE, dbt Cloud CLIそれぞれで対応しているコマンドが違うため、覚えておこうと思いました。
使うコマンドは限られるので、「よく使うコマンド」を参照ください。
今後もアップデートしていく予定です。
使い方とか要望があれば、随時更新します。
コマンド一覧
すべてにサポート（dbt Core/dbt Cloud CLI/dbt Cloud IDE)
| コマンド |
説明文 |
dbt build |
選択されたすべてのリソース（model, seed, snapshot, test)をビルドおよびテストする |
dbt clean |
dbtプロジェクト内のdbt_packagesおよびtargetフォルダを削除します。dbt_project.yml内のclean-targetsに指定したフォルダが削除されます。 |
dbt clone |
指定された状態から選択されたモデルをクローンする |
dbt compile |
プロジェクト内のモデルをコンパイルする（実行はしない） |
dbt deps |
プロジェクトの依存関係をダウンロードする |
dbt docs |
プロジェクトのドキュメントを生成する |
dbt list |
dbtプロジェクトで定義されたリソースを一覧表示する |
dbt run |
プロジェクト内のモデルを実行する |
dbt parse |
プロジェクトを解析し、詳細なタイミング情報を書き込む |
dbt retry |
最後に実行したdbtコマンドを失敗したポイントから再試行する |
dbt run-operation |
マクロを呼び出し、データベースに対して任意のメンテナンスSQLを実行する |
dbt seed |
CSVファイルをデータベースにロードする |
dbt show |
変換後のテーブル行をプレビューする |
dbt snapshot |
プロジェクト内で定義された「スナップショット」ジョブを実行する |
dbt source |
ソースデータを扱うためのツールを提供する（ソースが「新鮮」であることを検証するなど） |
dbt test |
プロジェクト内で定義されたテストを実行する |
dbt Coreのみ
| コマンド |
説明文 |
dbt init |
新しいdbtプロジェクトを初期化する |
dbt Cloud CLIのみ
| コマンド |
説明文 |
dbt cancal |
最新の呼び出しをキャンセルする |
dbt environment |
dbt Cloud環境と対話する機能を提供する |
dbt reattach |
最新の呼び出しに再接続し、ログやアーティファクトを取得する |
dbt Cloud IDE, dbt Coreに対応
| コマンド |
説明文 |
dbt debug |
dbtの接続およびプロジェクトをデバッグする |
dbt Core / dbt Cloud CLI
| コマンド |
説明文 |
dbt help |
任意のコマンドに関するヘルプ情報を表示する |
よく使うコマンド
| コマンド |
説明文 |
dbt run --select tag:{タグ名}[,tag:{タグ名}] |
タグを指定してモデルを生成（カンマ区切りで複数） |
dbt run --select {モデル名} |
モデル名を直接指定して実行する |
dbt test |
モデルのテストを行う |
dbt docs generate |
dbt docs generateの後にdbt docs serveを実行することでドキュメントを閲覧できる。 |
dbt seed |
dbt_project.yml内に定義したseedsのフォルダにあるファイルを読み取りデータベースに書き込みます。固定値を持つデータ等と取り込みたい場合に便利 |
dbt build |
モデルの実行,テストの実行,スナップショットの取得,seedの実行を一括で行ってくれます。運用時はこれを設定しておくとテストも実行してくれるので便利ですね |
|
