Dataform CLI 参考文档

本文档介绍了开源 Dataform 命令行界面 (CLI) 的命令。

Dataform CLI 命令

开源 Dataform CLI 提供用于初始化、编译、 测试和运行 Dataform Core 本地(而非 Google Cloud)的命令。

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 显示帮助信息 [boolean]。
--version 显示 Dataform CLI 的版本号 [boolean]。

命令选项和示例

如需查看特定于命令的标志、共享项目配置 替换标志和使用示例的完整列表,请参阅 GitHub 上的 Dataform CLI 参考文档。