Dataform CLI 參考資料

本文說明開放原始碼 Dataform 指令列介面 (CLI) 的指令。

Dataform CLI 指令

開放原始碼 Dataform CLI 提供指令,可在本機 ( Google Cloud外部) 初始化、編譯、測試及執行 Dataform 核心。

Dataform CLI 指令 說明
dataform help 顯示所有 Dataform CLI 指令的說明。
dataform help [command] 顯示指定指令的說明。
dataform init [project-dir] [default-database] [default-location] 建立新的 Dataform 專案。
dataform install [project-dir] 為指定的 Dataform 專案安裝 NPM 依附元件。
dataform init-creds [project-dir] 建立 .df-credentials.json 檔案,供 Dataform 存取 Google Cloud API 時使用。
dataform compile [project-dir] 編譯指定的 Dataform 專案,並列印編譯後依附元件圖表的摘要,但不會針對 BigQuery 執行。傳遞 --json 或 --dot,以取得 JSON 或 Graphviz DOT 輸出。
dataform test [project-dir] 在 BigQuery 執行指定 Dataform 專案的單元測試。
dataform run [project-dir] 在 BigQuery 上執行指定 Dataform 專案的指令碼。
dataform format [project-dir] 設定指定 Dataform 專案檔案的格式。
--help 顯示說明 [布林值]。
--version 顯示 Dataform CLI 的版本號碼 [布林值]。

指令選項和範例

如需指令專屬旗標、共用專案設定覆寫旗標和使用範例的完整清單,請參閱 GitHub 上的 Dataform CLI 參考資料。