Referencia de la CLI de Dataform

En este documento, se describen los comandos de la interfaz de línea de comandos (CLI) de Dataform de código abierto.

Comandos de la CLI de Dataform

La CLI de Dataform de código abierto proporciona comandos para inicializar, compilar, probar y ejecutar Dataform Core de forma local, fuera de Google Cloud.

Comando de la CLI de Dataform Descripción
dataform help Muestra ayuda para todos los comandos de la CLI de Dataform.
dataform help [command] Muestra ayuda para el comando especificado.
dataform init [project-dir] [default-database] [default-location] Crea un proyecto nuevo de Dataform.
dataform install [project-dir] Instala las dependencias de NPM para el proyecto de Dataform especificado.
dataform init-creds [project-dir] Crea un archivo .df-credentials.json para que Dataform lo use cuando acceda a las Google Cloud APIs.
dataform compile [project-dir] Compila el proyecto de Dataform especificado y muestra un resumen del gráfico de dependencias compilado sin ejecutarlo en BigQuery. Pasa --json o --dot para obtener resultados en JSON o Graphviz DOT output.
dataform test [project-dir] Ejecuta las pruebas unitarias del proyecto de Dataform especificado en BigQuery.
dataform run [project-dir] Ejecuta las secuencias de comandos del proyecto de Dataform especificado en BigQuery.
dataform format [project-dir] Da formato a los archivos del proyecto de Dataform especificado.
--help Muestra ayuda [boolean].
--version Muestra el número de versión de la CLI de Dataform [boolean].

Opciones y ejemplos de comandos

Para obtener la lista completa de marcas específicas de comandos, marcas de anulación de configuración de proyectos compartidos y ejemplos de uso, consulta la referencia de la CLI de Dataform en GitHub.