Dataform CLI commands
The open-source Dataform CLI provides commands to initialize, compile, test, and run Dataform core locally, outside of Google Cloud, to deploy assets to the following data warehouses:
- BigQuery
- Snowflake
- Redshift
- Azure SQL Data Warehouse
- Postgres
| Dataform CLI command | Description |
|---|---|
dataform help |
Shows help for all Dataform CLI commands. |
dataform help [command] |
Shows help for the specified command. |
dataform init [warehouse] [project-dir] |
Creates a new Dataform project. |
dataform install [project-dir] |
Installs NPM dependencies for the specified Dataform project. |
dataform init-creds [warehouse] [project-dir] |
Creates a .df-credentials.json file for Dataform to
use when accessing your data warehouse. |
dataform compile [project-dir] |
Compiles the specified Dataform project. Produces JSON output describing the non-executable graph. |
dataform test [project-dir] |
Runs the specified Dataform project's unit tests on the configured data warehouse. |
dataform run [project-dir] |
Runs the specified Dataform project's scripts on the configured data warehouse. |
dataform format [project-dir] |
Formats the specified Dataform project's files. |
dataform listtables [warehouse] |
Lists tables from the configured data warehouse. |
dataform gettablemetadata [warehouse] [schema] [table] |
Fetches metadata for the specified table. |
--help |
Shows help [boolean]. |
--version |
Shows the version number of the Dataform CLI [boolean]. |