Parâmetros de consulta

Um parâmetro de consulta permite substituir valores em uma consulta em tempo de execução. Qualquer string entre 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. Os parâmetros de consulta são mais flexíveis que os filtros de consulta e só devem ser usados nos casos em que os filtros de consulta não são suficientes.

Adicionar um parâmetro de consulta

1. Digite Cmd + I. O parâmetro é inserido no cursor do texto e a caixa de diálogo Adicionar parâmetro é exibida.

   • Palavra-chave: A palavra-chave que representa o parâmetro na query.

   • Título: O título que aparece sobre o widget. Por default, o título é igual à palavra-chave.

   • Tipo: os tipos suportados são Texto, Número, Data, Data e Hora, Data e Hora (com Segundos), Lista dropdown e Lista dropdown baseada em query . O default é Texto.

2. Insira a palavra-chave, substitua opcionalmente o título e selecione o tipo de parâmetro.

3. Clique em Adicionar parâmetro.

4. No widget de parâmetro, defina o valor do parâmetro.

5. Clique em Aplicar alterações.

6. Clique em Salvar.

Como alternativa, digite chaves duplas {{ }} e clique no ícone de engrenagem próximo ao widget de parâmetro para editar as configurações.

Para reexecução da query com um valor de parâmetro diferente, insira o valor no widget e clique em Apply Changes.

Editar um parâmetro de consulta

Para editar um parâmetro, clique no ícone de engrenagem ao lado do widget de parâmetro. Para impedir que usuários que não possuem a query alterem o parâmetro, clique em Mostrar apenas resultados. A caixa de diálogo do parâmetro <Keyword> é exibida.

Remover um parâmetro de consulta

Para remover um parâmetro de consulta, exclua o parâmetro da sua consulta. O widget de parâmetro desaparece e você pode reescrever sua consulta usando valores estáticos.

Alterar a ordem dos parâmetros

Para alterar a ordem em que os parâmetros são exibidos, você pode clicar e arrastar cada parâmetro para a posição desejada.

Tipos de parâmetro de consulta

Texto

Recebe uma string como entrada. Barra invertida, aspas simples e duplas têm escape e o Databricks adiciona aspas a esse parâmetro. Por exemplo, uma string como mr's Li"s é transformada em 'mr\'s Li\"s' Um exemplo de uso disso poderia ser

SELECT * FROM users WHERE name={{ text_param }}

Número

Toma um número como sua entrada. Um exemplo de uso disso pode ser

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

Lista suspensa

Para restringir o escopo de possíveis valores de parâmetro ao executar uma consulta, use o tipo de parâmetro dropdown Lista . Um exemplo seria SELECT * FROM users WHERE name='{{ dropdown_param }}'. Quando selecionado no painel de configurações de parâmetros, uma caixa de texto aparece onde você insere os valores permitidos, cada valor separado por uma nova linha. listas dropdown são parâmetros de texto. Para usar datas ou datas e horas em sua lista dropdown , insira-as no formato exigido pela sua fonte de dados. As strings não têm escape. Você pode escolher entre um dropdown de valor único ou de vários valores.

• Valor único: São necessárias aspas simples ao redor do parâmetro.

• Vários valores: alterne a opção Permitir vários valores . No menu suspenso Cotação , escolha se deseja deixar os parâmetros como inseridos (sem aspas) ou colocar os parâmetros entre aspas simples ou duplas. Você não precisa adicionar aspas ao redor do parâmetro se escolher aspas.

Altere sua cláusula WHERE para usar a palavra-chave IN em sua consulta.

SELECT ...
FROM   ...
WHERE field IN ( {{ Multi Select Parameter }} )

O widget de seleção múltipla de parâmetros permite passar vários valores para o banco de dados. Se você selecionar a opção Aspas Duplas para o parâmetro Cotação , sua query refletirá o seguinte formato: WHERE IN ("value1", "value2", "value3")

Lista suspensa baseada em consulta

Toma o resultado de uma consulta como entrada. Ele tem o mesmo comportamento do parâmetro Listadropdown . Você deve salvar a Databricks SQL dropdown consulta da lista para usá-la como entrada em outra consulta.

1. Clique na listadropdown Baseada em query em Tipo no painel de configurações.

2. Clique no campo Consulta e selecione uma consulta. Se a sua consulta de destino retornar um grande número de registros, o desempenho será prejudicado.

Se sua query de destino retornar mais de uma coluna, Databricks SQL usará a primeira . Se sua query de destino retornar colunas name e value, Databricks SQL preencherá o widget de seleção de parâmetro com a coluna name, mas executará a query com o value associado.

Por exemplo, suponha que a query a seguir retorne os dados da tabela.

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

Valor	nome
1001	John Smith
1002	Jane Doe
1003	Mesas Bobby

Quando Databricks executar a query, o valor passado para o banco de dados seria 1001, 1002 ou 1003.

Data e hora

O Databricks possui diversas opções para parametrizar valores de data e carimbo de data/hora, incluindo opções para simplificar a parametrização de intervalos de tempo. Selecione entre três opções de precisão variável:

Opção	Precisão	Tipo
Data	dia	DATE
Data e hora	minuto	TIMESTAMP
Data e hora (com segundos)	segundo	TIMESTAMP

Ao escolher uma opção de parâmetro Range , você cria dois parâmetros designados pelos sufixos .start e .end . Todas as opções passam parâmetros para sua consulta como strings literais; O Databricks exige que você coloque valores de data e hora entre aspas simples ('). Por exemplo:

-- Date parameter
SELECT *
FROM usage_logs
WHERE date = '{{ date_param }}'

-- Date and Time Range parameter
SELECT *
FROM usage_logs
WHERE modified_time > '{{ date_range.start }}' and modified_time < '{{ date_range.end }}'

Os parâmetros de data usam uma interface de seleção de calendário e default a data e a hora atuais.

Observação

O parâmetro Intervalo de datas retorna apenas resultados corretos para colunas do tipo DATE . Para colunas TIMESTAMP , use uma das opções de intervalo de data e hora.

Valores dinâmicos de data e intervalo de datas

Quando você adiciona um parâmetro de data ou intervalo de datas à sua query, o widget de seleção mostra um ícone de raio azul. Clique nele para exibir valores dinâmicos como today, yesterday, this week, last week, last month ou last year. Esses valores são atualizados dinamicamente.

Importante

As datas dinâmicas e os intervalos de datas não são compatíveis com query programada .

Usando parâmetros de consulta em painéis

Opcionalmente, as consultas podem usar parâmetros ou valores estáticos. Quando uma visualização baseada em uma consulta parametrizada é adicionada a um painel, a visualização pode ser configurada para usar:

• Parâmetro do widget

  Os parâmetros do widget são específicos para uma única visualização em um painel, aparecem no painel de visualização e os valores dos parâmetros especificados aplicam-se somente à consulta subjacente à visualização.

• Parâmetro do painel

  Os parâmetros do painel podem ser aplicados a diversas visualizações. Quando você adiciona uma visualização baseada em uma consulta parametrizada a um painel, o parâmetro será adicionado como parâmetro do painel por default. Os parâmetros do painel são configurados para uma ou mais visualizações em um painel e aparecem na parte superior do painel. Os valores de parâmetro especificados para um parâmetro do painel se aplicam a visualizações que reutilizam esse parâmetro específico do painel. Um painel pode ter vários parâmetros, cada um dos quais pode ser aplicado a algumas visualizações e não a outras.

• valor estático

  Valores estáticos são usados no lugar de um parâmetro que responde às alterações. Os valores estáticos permitem que você codifique um valor no lugar de um parâmetro e farão com que o parâmetro “desapareça” do painel ou widget onde apareceu anteriormente.

Ao adicionar uma visualização contendo uma query parametrizada , você pode escolher o título e a fonte do parâmetro na query de visualização clicando no ícone de lápis apropriado. Você também pode selecionar a palavra-chave e um valor default . Consulte Propriedades dos parâmetros.

Depois de adicionar uma visualização a um painel, acesse a interface de mapeamento de parâmetros clicando nas reticências verticais no canto superior direito de um widget de painel e, em seguida, clicando em Alterar configurações do widget.

Propriedades do parâmetro

• Título: o nome de exibição que aparece ao lado do seletor de valor em seu painel. O padrão é o parâmetro Keyword. Para editá-lo, clique no ícone de lápis . Os títulos não são exibidos para parâmetros de painel estático porque o seletor de valor está oculto. Se você selecionar Valor estático como Fonte de valor, o campo Título ficará esmaecido.

• Palavra-chave: as strings literais para este parâmetro na consulta subjacente. Isso é útil para depuração se o seu painel não retornar os resultados esperados.

• valordefault : o valor usado se nenhum outro valor for especificado. Para alterar isso na tela de consulta, execute a consulta com o valor do parâmetro desejado e clique no botão Salvar .

• Origem do valor: a origem do valor do parâmetro. Clique no ícone de lápis para escolher uma fonte.

  • Novo parâmetro do painel: crie um novo parâmetro no nível do painel. Isso permite definir um valor de parâmetro em um local do painel e mapeá-lo para várias visualizações.

  • Parâmetro de painel existente: Mapeie o parâmetro para um parâmetro de painel existente. Você deve especificar qual parâmetro de painel pré-existente.

  • Parâmetro do widget: exibe um seletor de valor dentro do widget do painel. Isso é útil para parâmetros únicos que não são compartilhados entre widgets.

  • Valor estático: escolha um valor estático para o widget, independentemente dos valores usados em outros widgets. Os valores de parâmetros mapeados estaticamente não exibem um seletor de valor em nenhum lugar do painel, que é mais compacto. Isso permite que você aproveite a flexibilidade dos parâmetros de consulta sem sobrecarregar a interface do usuário em um painel quando não se espera que determinados parâmetros sejam alterados com frequência.

  

Perguntas frequentes (FAQ)

Posso reutilizar o mesmo parâmetro várias vezes em uma única consulta?

Sim. Use o mesmo identificador nas chaves. Este exemplo usa o parâmetro {{org_id}} duas vezes.

SELECT {{org_id}}, count(0)
FROM queries
WHERE org_id = {{org_id}}

Posso usar vários parâmetros em uma única consulta?

Sim. Use um nome exclusivo para cada parâmetro. Este exemplo usa dois parâmetros: {{org_id}} e {{start_date}}.

SELECT count(0)
FROM queries
WHERE org_id = {{org_id}} AND created_at > '{{start_date}}'