Sintaxe de parâmetro Mustache

importante

A sintaxe de parâmetros Mustache é suportada apenas no editor SQL legado. A Databricks recomenda o uso de marcadores de parâmetros nomeados para novas consultas. Se você copiar uma consulta usando a sintaxe Mustache para um Notebook, editor dataset AI/BI dashboard ou espaço Genie , deverá convertê-la em marcadores de parâmetros nomeados antes de executá-la.

No editor SQL legado, qualquer string envolvida em chaves duplas ({{ }}) é tratada como um parâmetro de consulta. Um widget aparece acima do painel de resultados, onde você define o valor do parâmetro.

Adicionar parâmetro de bigode

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 , altere opcionalmente 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 .

Alternativamente, digite {{ }} diretamente na consulta e clique no ícone de engrenagem no widget de parâmetros para configurá-lo.

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âmetros. Para impedir que usuários que não são os proprietários da consulta alterem o valor do parâmetro, clique em Mostrar somente resultados .

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

Reordenar : Clique e arraste os widgets de parâmetros para a ordem desejada.

Tipos de widgets

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

Texto

Recebe uma string como entrada. A barra invertida, as aspas simples e as aspas duplas são escapadas automaticamente. O Databricks adiciona aspas em torno do valor.

SQL

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

Número

Recebe um número como entrada.

SQL

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

Data e hora

Parametriza valores de data e hora. 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 strings literais e devem estar entre aspas simples na sua consulta:

SQL

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

Ao selecionar uma opção de intervalo , o Databricks cria dois parâmetros usando os sufixos .start e .end :

SQL

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

nota

O widget de intervalo de datas retorna resultados corretos apenas para colunas do tipo DATE . Para colunas de registro de data e 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 para selecionar valores dinâmicos como today, yesterday, this week, last week, last month ou last year. Esses valores são atualizados automaticamente.

importante

Valores de data dinâmicos não são compatíveis com consultas agendadas.

Lista suspensa

Restringe a entrada a uma lista estática predefinida. Suporta seleção de valor único e de múltiplos valores.

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

• Múltiplos valores : Ative a opção "Permitir múltiplos valores" nas configurações do widget. Use a opção Aspas para controlar se os valores serão delimitados por aspas simples, aspas duplas ou nenhuma. Atualize sua cláusula WHERE para usar IN:

  SQL

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

  Com aspas duplas selecionadas, a consulta resulta em: WHERE status IN ("value1", "value2", "value3").

Os valores da lista suspensa são strings. Para usar datas ou horários, insira-os no formato exigido pela sua fonte de dados.

Lista suspensa baseada em consulta

Preenche as opções dropdown a partir de uma consulta salva. Funciona como uma lista suspensa, mas as opções são dinâmicas.

1. Em Tipo , no painel de configurações, selecione a lista suspensa Baseado em consulta .
2. Clique no campo Consulta e selecione uma consulta salva.

Se a consulta retornar mais de uma coluna, o Databricks usará a primeira coluna. Se a consulta retornar colunas nomeadas name e value, o widget exibe a coluna name , mas passa a coluna value associada para a consulta em tempo de execução.

Exemplo:

SQL

SELECT user_uuid AS 'value', username AS 'name' FROM users

Valor	name
1001	João Smith
1002	Jane Doe
1003	Mesas Bobby

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

nota

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

Utilizar parâmetros Mustache em dashboards legados

Opcionalmente, as consultas podem usar parâmetros ou valores estáticos. Ao adicionar uma visualização baseada em uma consulta parametrizada a um painel, você pode configurar cada parâmetro para usar uma das três fontes de valor:

• Parâmetro do widget : Aplica-se somente à visualização específica à qual pertence. O seletor de valores aparece dentro do painel de visualização.
• Parâmetro do painel : Pode ser aplicado a várias visualizações no painel. O seletor de valores aparece na parte superior do painel. Adicionada por default quando você adiciona uma visualização parametrizada a um painel.
• Valor estático : Substitui o parâmetro por um valor fixo. O seletor de valores está oculto, mantendo a interface do painel de controle limpa para parâmetros que não precisam ser alterados.

Para acessar as configurações de mapeamento de parâmetros, clique no menu de três pontos (kebab) em um widget do painel e selecione Alterar configurações do widget .

Propriedades dos parâmetros do painel de controle

Propriedade	Descrição
Título	O nome de exibição mostrado ao lado do seletor de valores. O valor padrão é a palavra-chave do parâmetro. Não mostrado para parâmetros estáticos.
Palavra-chave	As strings literais para este parâmetro na consulta subjacente. Útil para depuração de resultados inesperados.
Valor padrão	O valor utilizado quando nenhum outro valor é especificado. Para alterar, execute a consulta com o valor desejado e clique em Salvar .
Origem do valor	Controla a origem do valor do parâmetro. Opções: Novo parâmetro do painel , Parâmetro existente do painel , Parâmetro do widget , Valor estático .