Dataform CLI リファレンス

このドキュメントでは、オープンソースの Dataform コマンドライン インターフェース(CLI)のコマンドについて説明します。

Dataform CLI コマンド

オープンソースの Dataform CLI には、Google Cloud の外部で Dataform コアを初期化、コンパイル、テスト、実行するためのコマンドが用意されています。

Dataform CLI コマンド 説明
dataform help すべての Dataform CLI コマンドのヘルプを表示します。
dataform help [command] 指定したコマンドのヘルプを表示します。
dataform init [project-dir] 新しい Dataform プロジェクトを作成します。
dataform install [project-dir] 指定した Dataform プロジェクトの NPM 依存関係をインストールします。
dataform init-creds [project-dir] Google Cloud APIs へのアクセス時に使用する Dataform 用の .df-credentials.json ファイルを作成します。
dataform compile [project-dir] 指定した Dataform プロジェクトをコンパイルします。実行不可能なグラフを記述する JSON 出力を生成します。
dataform test [project-dir] 指定した Dataform プロジェクトの単体テストを BigQuery で実行します。
dataform run [project-dir] 指定した Dataform プロジェクトのスクリプトを BigQuery で実行します。
dataform format [project-dir] 指定した Dataform プロジェクトのファイルをフォーマットします。
--help ヘルプ [boolean] を表示します。
--version Dataform CLI のバージョン番号が表示されます(ブール値)。