Usar parâmetros de painel

Os parâmetros de painel são uma forma de tornar os painéis interativos, permitindo que os visualizadores usem seletores de valor único e seletores de data para inserir valores específicos em consultas de conjunto de dados em runtime. Por exemplo, os parâmetros podem filtrar dados com base em critérios como datas e categorias de produto antes de serem agregados em uma consulta SQL, permitindo uma consulta mais eficiente e análise precisa.

Os parâmetros são adicionados a conjuntos de dados e conectados a um ou mais widgets na tela de um painel por um autor ou editor do painel. Os visualizadores do painel interagem com os dados do painel selecionando valores em widgets de filtro no runtime. Isso executa novamente as consultas associadas e apresenta visualizações criadas nos dados filtrados.

Os parâmetros modificam diretamente a consulta, que pode ser eficaz. Os filtros de conjunto de dados também podem oferecer interatividade do painel, mais recursos e melhor desempenho com conjuntos de dados maiores do que parâmetros. Confira Filtros.

Adicionar um parâmetro

Você deve ter pelo menos permissões Pode editar no painel de rascunho para adicionar um parâmetro a um conjunto de dados de painel. Você pode adicionar parâmetros diretamente às consultas do conjunto de dados na guia Dados.

Para adicionar um parâmetro a uma consulta:

1. Coloque o cursor onde você deseja colocar o parâmetro em sua consulta.

2. Clique em Adicionar Parâmetro para inserir um novo parâmetro.

   Isso cria um novo parâmetro com o nome padrão parameter. Para alterar o nome padrão, substitua-o no editor de consultas. Você também pode adicionar parâmetros digitando essa sintaxe no editor de consultas.

Editar um parâmetro

Para editar um parâmetro:

1. Clique em ao lado do nome do parâmetro. A caixa de diálogo Detalhes do parâmetro é exibida.

   A caixa de diálogo inclui as seguintes opções de configuração:

   • Palavra-chave: a palavra-chave que representa o parâmetro na consulta. Isso só pode ser alterado atualizando diretamente o texto na consulta.
   • Nome de exibição: o nome no editor de filtro. Por padrão, o título é o mesmo que a palavra-chave.
   • Tipo: os tipos com suporte incluem Cadeia de caracteres, Data, Data e Hora e Numérico.
     • O tipo padrão é Cadeia de caracteres.
     • O tipo de dados Numérico permite que você especifique entre Decimal e Inteiro. O tipo numérico padrão é Decimal.

2. Clique em outra parte da interface do usuário para fechar a caixa de diálogo.

Remover um parâmetro

Para remover um parâmetro, exclua-o da consulta.

Usar um parâmetro na tela do painel

Para adicionar um parâmetro ao seu painel:

1. Clique em Adicionar um filtro (campo/parâmetro).
2. Clique em ao lado de Parâmetros no painel de configuração.
3. Clique no nome do parâmetro para o visualizador usar com esse widget.

Incluir parâmetros na URL

As configurações de parâmetro são armazenadas na URL, permitindo que os usuários coloquem indicares para manter o estado do painel, incluindo filtros e parâmetros pré-definidos, ou compartilhá-lo com outras pessoas para uma aplicação consistente dos mesmos filtros e parâmetros.

Exemplos de sintaxe de parâmetro

(1) Valores são inseridos usando a função format_string. Consulte a Função format_string.

Os exemplos a seguir fornecem um caso de uso seguido de sintaxe de exemplo.

• Inclua somente registros antes de uma data específica.

  WHERE date_field < :date_param

• Inclua somente preços abaixo de um preço específico.

  WHERE price < :max_price

• Selecione a tabela a ser usada em uma consulta.

  SELECT * FROM IDENTIFIER(:param)

• Altere o catálogo, esquema e tabela usados em uma consulta.

  SELECT * FROM IDENTIFIER(:catalog || '.' || :schema || '.' || :table)

• Combine dois parâmetros com colchetes para criar números de telefone formatados.

  O exemplo a seguir usa a função format_string para inserir valores. Consulte a Função format_string.

  format_string('(%d) %d', :area_code, :phone_number)

Importante

Permitir que os visualizadores de painel acessem dados por meio de seleções de parâmetro, como nomes de tabela ou catálogo, pode levar à exposição acidental de informações confidenciais. Se você estiver publicando um painel com essas opções, o Azure Databricks recomenda não inserir credenciais no painel publicado.

Parâmetros de painel versus Parâmetros de consulta SQL do Databricks

Os parâmetros de painel usam a mesma sintaxe que os marcadores de parâmetro nomeados. Consulte Marcadores de parâmetros nomeados. Os painéis não dão suporte a parâmetros de estilo SQL do Databricks.