Referencia de la CLI de Dataform

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

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, con el fin de implementar elementos en los siguientes almacenes de datos:

  • BigQuery
  • Snowflake
  • Redshift
  • Azure Synapse Analytics (anteriormente Azure SQL Data Warehouse)
  • Postgres
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 [warehouse] [project-dir] Crea un proyecto de Dataform nuevo.
dataform install [project-dir] Instala dependencias de NPM para el proyecto de Dataform especificado.
dataform init-creds [warehouse] [project-dir] Crea un archivo .df-credentials.json para que Dataform use cuando se acceda a tu almacén de datos.
dataform compile [project-dir] Compila el proyecto de Dataform especificado. Produce un resultado JSON que describe el grafo no ejecutable.
dataform test [project-dir] Ejecuta las pruebas de unidades del proyecto de Dataform especificado en el almacén de datos configurado.
dataform run [project-dir] Ejecuta las secuencias de comandos del proyecto de Dataform especificadas en el almacén de datos configurado.
dataform format [project-dir] Aplica formato a los archivos del proyecto de Dataform especificados.
dataform listtables [warehouse] Enumera las tablas del almacén de datos configurado.
dataform gettablemetadata [warehouse] [schema] [table] Recupera metadatos para la tabla especificada.
--help Muestra ayuda [booleano].
--version Muestra el número de versión de la CLI de Dataform [booleano].