Configurar parâmetros do trabalho
Este artigo descreve a funcionalidade do parâmetro de trabalho e a configuração de parâmetros de trabalho com a interface do usuário do workspace do Databricks. Você também pode adicionar parâmetros de trabalho às definições JSON e YAML usadas com a API REST, CLI e DABs. Confira API de trabalhos, O que é a CLI do Databricks? e O que são Databricks Asset Bundles?.
O que são parâmetros de trabalho?
Os parâmetros de trabalho são pares de chave-valor que permitem parametrizar trabalhos com valores estáticos ou dinâmicos padrão. Opcionalmente, você pode substituir os parâmetros configurados em um trabalho ao acionar uma nova execução. Confira Executar um trabalho com parâmetros diferentes.
As chaves de parâmetro de trabalho só podem conter _ - . ou caracteres alfanuméricos. Os valores de parâmetro são definidos como cadeias de caracteres ou referências de valor dinâmico. Confira O que é uma referência de valor dinâmico?.
Observação
Você pode usar qualquer JSON válido como um valor de parâmetro. Por exemplo, o tipo de tarefa For each pode analisar listas como as seguintes:
[1, 2, 3]
['a', 'b', 'c']
Adicionar ou editar parâmetros de trabalho
Use a caixa de diálogo Parâmetros de trabalho para adicionar novos parâmetros, editar chaves e valores de parâmetros existentes ou excluir parâmetros.
Para editar parâmetros com a interface do usuário do workspace, selecione um trabalho existente aplicando as seguintes etapas:
- Clique em
Fluxos de trabalho na barra lateral. - Na coluna Nome, clique no nome do trabalho.
- Na barra lateral Detalhes do trabalho, clique em Editar parâmetros. A caixa de diálogo Parâmetros de trabalho é exibida.
- Adicione ou edite parâmetros usando os campos Chave e Valor.
- Clique em
para remover um parâmetro. - Clique em Salvar para aplicar suas alterações.
Observação
Clique em { } para listar as referências de valor dinâmico disponíveis. Selecione uma opção na lista para inseri-la no campo Valor.
Pushdown de parâmetro de trabalho
Os parâmetros de trabalho são enviados automaticamente como parâmetros de chave-valor para todas as tarefas que aceitam parâmetros de chave-valor, que incluem os seguintes tipos de tarefa:
- Notebook
- Python wheel (somente quando configurada com argumentos de palavra-chave)
- Consulta SQL, painel herdado ou arquivo
- Executar trabalho
Os parâmetros de trabalho transmitidos para tarefas são visíveis na configuração da tarefa na interface do usuário, juntamente com todos os parâmetros configurados na tarefa.
Importante
Os parâmetros de trabalho têm precedência sobre os parâmetros de tarefa. Se um parâmetro de trabalho e um parâmetro de tarefa tiverem a mesma chave, o parâmetro de trabalho substituirá o parâmetro de tarefa.
Referências de valor dinâmico a parâmetros de trabalho
Todas as tarefas que aceitam referências de valor dinâmico podem acessar parâmetros de trabalho.
Use a referência de valor dinâmico {{job.parameters.<name>}}, substituindo <name> pelo key que identifica o parâmetro.
Executar um trabalho com parâmetros diferentes
Você pode substituir parâmetros de trabalho configurados ou adicionar novos parâmetros ao executar um trabalho com parâmetros diferentes. Confira Executar um trabalho com parâmetros diferentes.
Você também pode substituir os parâmetros de trabalho ao reparar uma execução de trabalho. Consulte Reexecutar tarefas com falha e ignoradas.