Compartilhar via


Sintaxe do parâmetro Mustache

Importante

A sintaxe do parâmetro Mustache tem suporte somente no editor SQL herdado. O Databricks recomenda o uso de marcadores de parâmetro nomeados para novas consultas. Se você copiar uma consulta utilizando a sintaxe 'mustache' em um notebook, editor de conjunto de dados do painel de IA/BI ou espaço do Genie, antes de executá-la, deverá convertê-la em marcadores de parâmetro nomeados.

No editor de SQL herdado, qualquer cadeia de caracteres encapsulada em chaves duplas ({{ }}) é tratada como um parâmetro de consulta. Um widget aparece acima do painel de resultados onde você definiu o valor do parâmetro.

Adicionar um parâmetro mustache

  1. Pressione Cmd + I. O parâmetro é inserido na posição do cursor e a caixa de diálogo Adicionar Parâmetro é exibida.
  2. Insira a palavra-chave, opcionalmente, altere o Título e selecione um Tipo.
  3. Clique em Adicionar Parâmetro.
  4. Defina o valor do parâmetro no widget.
  5. Clique em Aplicar alterações.
  6. Clique em Salvar.

Como alternativa, digite {{ }} diretamente na consulta e clique no ícone de engrenagem no widget de parâmetro para configurá-la.

Para executar novamente a consulta com um valor diferente, atualize o widget e clique em Aplicar Alterações.

Editar, remover e reordenar parâmetros

Editar: clique no ícone de engrenagem ao lado do widget de parâmetro. Para impedir que os usuários que não possuem a consulta alterem o valor do parâmetro, clique em Mostrar Somente Resultados.

Remover: exclua o marcador de parâmetro da consulta. O widget é removido automaticamente.

Reordenar: clique e arraste widgets de parâmetro para a ordem desejada.

Tipos de widget

Os seguintes tipos de widget estão disponíveis:

Texto

Aceita uma cadeia de caracteres como entrada. As aspas invertidas, simples e duplas são escapadas automaticamente. Azure Databricks adiciona aspas ao redor do valor.

SELECT * FROM samples.tpch.customer WHERE c_name = {{ name_param }}

Número

Usa um número como entrada.

SELECT * FROM users WHERE age = {{ number_param }}

Data e hora

Parametriza valores de data e timestamp. Três opções estão disponíveis:

Tipo Precisão
Data Dia
Data e Hora Minuto
Data e hora (com segundos) Segundo

Todos os valores de data e hora são passados como literais de cadeia de caracteres e devem ser encapsulados em aspas simples em sua consulta:

SELECT * FROM usage_logs WHERE date = '{{ date_param }}'

Quando você seleciona uma opção Range, Azure Databricks cria dois parâmetros usando sufixos .start e .end:

SELECT * FROM usage_logs
WHERE modified_time > '{{ date_range.start }}'
AND modified_time < '{{ date_range.end }}'

Observação

O widget Intervalo de Datas retorna resultados corretos somente para colunas do tipo DATE. Para colunas de carimbo de data/hora, use um widget de intervalo de data e hora.

Valores de data dinâmicos: os widgets de data incluem um ícone de raio azul. Clique nele para selecionar valores dinâmicos comotoday, , yesterday, this week, last week, ou last monthlast year. Esses valores são atualizados automaticamente.

Importante

Os valores de data dinâmica não são compatíveis com consultas agendadas.

Restringe a entrada a uma lista estática predefinida. Dá suporte à seleção de valor único e de vários valores.

  • Valor único: encapsular o parâmetro entre aspas simples na consulta.

  • Multivalidade: habilitar Permitir vários valores nas configurações do widget. Use a opção Aspas para controlar se os valores são colocados entre aspas simples, aspas duplas ou nenhuma. Atualize sua WHERE cláusula para usar IN:

    SELECT * FROM orders WHERE status IN ( {{ status_param }} )
    

    Com aspas duplas selecionadas, a consulta é resolvida para: WHERE status IN ("value1", "value2", "value3").

Os valores de lista suspensa são cadeias de caracteres. Para usar datas ou marcadores de tempo, insira-os no formato exigido pela fonte de dados.

Lista suspensa baseada em consulta

Popula as opções de lista suspensa de uma consulta salva. Comporta-se como Lista Suspensa, mas as opções são dinâmicas.

  1. Em Tipo no painel de configurações, selecione Query Based Dropdown list.
  2. Clique no campo Consulta e selecione uma consulta salva.

Se a consulta retornar mais de uma coluna, Azure Databricks usará a primeira coluna. Se a consulta retornar colunas nomeadas name e value, o widget exibe a coluna name, mas passa o value associado à consulta para o runtime.

Exemplo:

SELECT user_uuid AS 'value', username AS 'name' FROM users
value nome
1001 John Smith
1002 Desconhecida
1003 Tabelas do Bobby

O valor passado para o banco de dados em runtime é 1001, 1002ou 1003, não o nome de exibição.

Observação

O desempenho diminuirá se a consulta de origem retornar um grande número de registros.