Referência da CLI do Dataform

Neste documento, descrevemos os comandos da interface de linha de comando (CLI) do Dataform de código aberto.

Comandos da CLI do Dataform

A CLI de código aberto do Dataform fornece comandos para inicializar, compilar, testar e executar o núcleo do Dataform localmente fora do Google Cloud para implantar recursos nos seguintes armazenamentos de dados:

  • BigQuery
  • Snowflake
  • Redshift
  • Azure SQL Data Warehouse
  • Postgres
Comando da CLI do Dataform Descrição
dataform help Mostra a ajuda de todos os comandos da CLI do Dataform.
dataform help [command] Mostra a ajuda do comando especificado.
dataform init [warehouse] [project-dir] Cria um novo projeto do Dataform.
dataform install [project-dir] Instala dependências do NPM para o projeto do Dataform especificado.
dataform init-creds [warehouse] [project-dir] Cria um arquivo .df-credentials.json para o Dataform usar ao acessar seu data warehouse.
dataform compile [project-dir] Compila o projeto especificado do Dataform. Produz a saída JSON que descreve o gráfico não executável.
dataform test [project-dir] Executa os testes de unidade do projeto do Dataform especificado no data warehouse configurado.
dataform run [project-dir] Executa os scripts do projeto do Dataform especificados no data warehouse configurado.
dataform format [project-dir] Formata os arquivos do projeto do Dataform especificado.
dataform listtables [warehouse] Lista as tabelas do data warehouse configurado.
dataform gettablemetadata [warehouse] [schema] [table] Busca metadados para a tabela especificada.
--help Mostra ajuda [boolean].
--version Mostra o número da versão da CLI do Dataform [boolean].