Skip to main content

Fragmentos

Snippets

Snippet SQL

Snippets são trechos reutilizáveis de consultas SQL ou nativas. Qualquer pessoa com permissão para o editor SQL pode criar e editar snippets, que ficam disponíveis para todos os autores de SQL.

Por exemplo, se você frequentemente realiza consultas que envolvem múltiplas tabelas, pode salvar o código SQL que faz o join dessas tabelas como um snippet para que você (e outros membros da organização) possam reutilizar esse código em várias perguntas.

Como criar um snippet

Veja uma consulta simples com join utilizando o Sample Database incluído no Analytics.

SELECT
  *
FROM
  orders AS o
  LEFT JOIN products AS p ON o.product_id = p.id

Vamos salvar tudo após o FROM como um snippet para reutilizar em outras consultas.

No editor SQL:

  1. Selecione uma parte do SQL que deseja salvar. Neste caso, selecione o seguinte código SQL:

    orders AS o
LEFT JOIN products AS p ON o.product_id = p.id
  2. Clique com o botão direito sobre a seleção.
  3. Escolha Salvar como snippet para criar o snippet. Uma janela modal aparecerá com o trecho SQL selecionado.
  4. Edite, dê nome e descrição para o snippet. Os nomes dos snippets devem ser únicos. Clique em salvar para criar o snippet.

Neste exemplo, nomeamos o snippet como “Orders and Products”. O snippet ficará disponível para qualquer pessoa usar. Veja como o snippet aparece no editor SQL:


SELECT
  *
FROM
  {{snippet: Orders and products}}

Ao escrever no editor SQL, você pode começar a digitar {{snippet:}} e o Analytics exibirá opções de autocompletar com os snippets disponíveis.

Nota: se você usar aliases em um snippet, deve respeitá-los também fora dele. Por exemplo, se um snippet define o alias products AS p, o código fora do snippet deverá usar o alias p para referenciar colunas dessa tabela (como p.column_name).

Menu de Snippets

A barra lateral do editor SQL possui um menu de Snippets que lista os snippets disponíveis e os arquivados.

Clique no ícone de snippet no lado direito do editor SQL, abaixo do ícone de Referência de Dados (Data Reference) e do ícone de Variáveis (χ). O Analytics abrirá uma barra lateral exibindo os snippets disponíveis.

Na barra de Snippets, você pode:

  • Criar um snippet. Clique no + no canto superior direito da barra lateral para criar um novo snippet.
  • Visualizar snippets. Clique na seta para baixo à direita do snippet para ver sua descrição e uma prévia do código SQL. Também há opção para editar o snippet.
  • Inserir um snippet. Clique no nome do snippet para inseri-lo na consulta na posição do cursor.
  • Pesquisar snippets. Se você salvou mais de 15 snippets, um ícone de busca (lupa) aparecerá à esquerda do botão +. Os resultados da busca incluem apenas snippets para os quais o usuário tem permissão. Pastas de snippets não aparecem nos resultados da busca.
  • Editar um snippet. Você pode alterar o nome, descrição e código do snippet.
  • Arquivar e desarquivar um snippet. No modal de edição, é possível arquivar um snippet, removendo-o do menu de snippets e das opções de autocompletar no editor SQL.

Editando snippets

Você pode editar um snippet a qualquer momento selecionando-o na barra lateral de Snippets do editor SQL. Clique na seta à direita do snippet e depois em Editar. É possível alterar o código SQL, o nome do snippet e sua descrição.

Editar snippets é uma ótima forma de atualizar várias perguntas de uma vez. Por exemplo, se você salvou o código para puxar dados de usuários das tabelas X, Y e Z no snippet User Data, e precisar mudar como esses dados são buscados (como adicionar uma coluna ou tabela), você pode atualizar o snippet, e todas as perguntas que usam esse snippet terão o código atualizado.

Alterar nome do snippet. Mudar o nome do snippet atualizará seu nome em todas as perguntas que o utilizam. Isso não quebra perguntas existentes (o SQL subjacente permanece igual), mas fique atento pois outros usuários podem ser surpreendidos ao verem o nome mudar para algo diferente, como de “Orders and Products” para “All the things”.

Alterar o SQL do snippet. Aqui vale um lembrete importante:

Cuidado: se você editar um snippet e incluir código quebrado, você irá quebrar todas as perguntas que usam esse snippet. Teste seu código antes de salvar alterações em um snippet existente.

Arquivando snippets

Arquivar snippets ajuda a manter snippets antigos ou menos relevantes organizados. Ao arquivar um snippet, ele deixa de aparecer no autocompletar e na lista principal da barra lateral do editor SQL.

Arquivar um snippet não afeta consultas existentes que já usam esse snippet, portanto, você pode arquivá-lo sem impacto nas perguntas.

Você pode acessar snippets arquivados pelo botão “arquivados” na parte inferior esquerda da barra lateral de snippets.

Embora não haja opção para deletar snippets, você pode arquivar e desarquivar snippets sempre que quiser.

Nota: dois snippets não podem ter o mesmo nome, mesmo que um deles esteja arquivado, pois ele pode ainda estar ativo em perguntas.

Permissões de snippets

Qualquer usuário que tenha permissão para o editor SQL em ao menos um banco de dados conectado poderá ver a barra lateral de snippets, além de criar, editar, arquivar e desarquivar quaisquer snippets — mesmo aqueles destinados a bancos de dados que o usuário não tem acesso para editar.

Alguns planos incluem funcionalidades adicionais para organizar snippets em pastas e definir permissões nessas pastas. Veja nossa documentação sobre pastas e permissões de snippets.

Saiba mais

Leia a documentação para outras versões do Analytics.

Back to top