Trechos de SQL

Benefícios da Adoção de Boas Práticas

A adoção das boas práticas descritas neste guia oferece diversos benefícios junto à Dadosfera, incluindo:

• Maior clareza e legibilidade dos dados: A padronização de trechos de SQL facilitam a compreensão dos dados por todos os usuários.
• Aumento da produtividade: A reutilização de consultas SQL economiza tempo e esforço dos usuários.
• Melhoria na colaboração: A documentação de trechos de SQL facilitam a colaboração entre os usuários e promovem o compartilhamento de conhecimento.
• Maior padronização de consultas dos dados: A padronização de consultas garantem a confiabilidade dos dados retornados.

Padronização de Trechos de SQL

Os Trechos SQL no Metabase podem ser utilizados para armazenar pequenas consultas SQL que podem conter filtros, métricas, junções ou qualquer outro fragmento comum de códigos SQL que podem ser reutilizados em diversas consultas no catálogo de dados. A grande vantagem de uso desses trechos está na capacidade de munir usuários com pouca experiência em SQL e aumentar a produtividade de usuários mais avançados.

No Catálogo Dadosfera, acesse o Metabase via módulo de Visualização

Como criar um trecho

Aqui está uma consulta simples com uma junção usando o banco de dados de exemplo incluído no Metabase em Sample Database.

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

Vamos salvar tudo depois de FROM como um snippet para reutilizar em outras consultas.

Acesse Consulta SQL

Realce um trecho do SQL que você deseja salvar. Nesse caso, selecionaremos o seguinte trecho SQL:

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

Clique com o botão direito na seção destacada.
Selecione Salvar como snippet para criar um Trecho de SQL. Um modal aparecerá com a instrução SQL que você destacou.

Edite, nomeie e descreva seu Trecho SQL. Os nomes dos trechos devem ser exclusivos. Clique no botão salvar para criar o Trecho SQL.

Nesse caso, nomeamos o trecho como “Pedidos e Produtos”. O snippet agora estará disponível para qualquer pessoa usar. Esta é a aparência do snippet no editor Consulta SQL:

SELECT *  
FROM {{snippet: Pedidos e Produtos}}

Observação: se você usar aliases em um Trecho SQL, também precisará observá-los fora do snippet. Por exemplo, se um Trecho SQL for o alias products AS p, o código fora do snippet precisará usar o alias p para referenciar colunas nessa tabela (como em p.column_name).

Menu Trechos de SQL

A barra lateral do editor Consulta SQL possui um menu de Trechos de SQL para listar os snippets disponíveis e arquivados.

Clique no ícone do snippet no lado direito do editor Consulta SQL

No menu Trechos de SQL, você pode:

• Criar um trecho. Clique em + no canto superior direito da barra lateral de Trechos de SQL para criar um novo snippet.
• Pré-visualizar trechos. Clique na seta para baixo à direita de um trecho para ver sua descrição e uma prévia de seu código SQL. Também existe a opção de editar o snippet.
• Inserir um trecho. Clique no nome de um trecho para inseri-lo em sua consulta no local atual do cursor.
• Pesquisar trechos. Se você salvou mais de 15 trechos, um ícone de pesquisa (a lupa clássica) aparecerá à esquerda do + botão.
• Editar um trecho. Você pode alterar o nome, a descrição e o código de um snippet.
• Arquivar e desarquivar um snippet. No modal Editar, você pode arquivar um snippet, que remove o snippet do menu de snippet e das opções de preenchimento automático no editor Consulta SQL.