Como usar o SQL Runner para criar consultas e Análises

O SQL Runner oferece uma maneira de acessar diretamente seu banco de dados e aproveitar esse acesso de várias maneiras. Com o SQL Runner, é fácil navegar pelas tabelas no esquema, usar uma Análise ad hoc de uma consulta SQL, executar consultas descritivas pré-escritas nos seus dados, consultar o histórico do SQL Runner, fazer o download dos resultados, compartilhar consultas, adicionar a um projeto do LookML como uma tabela derivada e realizar outras tarefas úteis.

Nesta página, descrevemos como executar consultas no SQL Runner, criar análises ad-hoc e usar o SQL Runner para depurar consultas. Consulte essas outras páginas de documentação para informações sobre:

Como executar consultas no SQL Runner

Para executar uma consulta no banco de dados, escreva a consulta SQL do zero, use uma Análise para criá-la ou execute uma consulta em um modelo do LookML. Também é possível usar o histórico para executar novamente uma consulta anterior.

Como escrever uma consulta SQL do zero

É possível usar o SQL Runner para criar e executar suas próprias consultas SQL no banco de dados. O Looker transmite a consulta para o banco de dados da mesma forma que você a escreveu. Portanto, verifique se a sintaxe da consulta SQL é válida para o dialeto do banco de dados. Por exemplo, cada dialeto tem funções SQL ligeiramente diferentes com parâmetros específicos que devem ser passados para a função.

  1. Insira uma consulta SQL na caixa de texto abaixo da barra Consulta.
  2. Também é possível selecionar um nome ou campo de tabela na lista de campos para incluí-lo na consulta na localização do cursor.
  3. Selecione Executar para executar a consulta no seu banco de dados.
  4. Confira os resultados na área Resultados. O SQL Runner carregará até 5.000 linhas do conjunto de resultados da consulta. Para dialetos SQL compatíveis com streaming, é possível fazer o download dos resultados para ver todo o conjunto de resultados.

Alguns programas SQL permitem executar várias consultas em uma série. No entanto, só é possível executar uma consulta por vez no SQL Runner. O SQL Runner também tem um limite de 65.535 caracteres em consultas, incluindo espaços em branco.

Depois de executar uma consulta, é possível adicioná-la a um projeto, obter o LookML de uma tabela derivada ou compartilhar a consulta.

Também é possível usar o SQL Runner para testar novas consultas ou testar consultas existentes. O destaque de erros do SQL Runner ajuda a testar e depurar consultas.

Como usar uma Análise para criar uma consulta SQL

Também é possível usar uma Análise para criar uma consulta e, em seguida, receber o comando SQL dessa consulta para usar no SQL Runner:

  1. Em uma Análise, selecione a guia SQL na barra Dados.
  2. A consulta SQL vai aparecer na barra Dados.
  3. Selecione Abrir no SQL Runner ou Explicar no SQL Runner para abrir a consulta no SQL Runner.

Quando uma consulta é adicionada à caixa de texto abaixo da barra Consulta, selecione Executar para consultar o banco de dados. Se preferir, edite a consulta e execute uma nova.

Como criar visualizações com o SQL Runner

Se o administrador do Looker tiver ativado o recurso Labs do SQL Runner Vis, será possível criar visualizações diretamente no SQL Runner.

Com o SQL Runner Vis ativado, os painéis do SQL Runner serão reorganizados. O painel de visualização aparece na parte de cima, o painel de resultados fica no meio e o painel de consulta aparece na parte de baixo.

  1. Depois de criar e executar uma consulta SQL, abra a guia Visualização para ver a visualização e escolher um tipo, assim como faria na página "Explorar".
  2. É possível editar a visualização usando o menu Configurações.
  3. É possível compartilhar visualizações criadas com o SQL Runner compartilhando o URL. As personalizações feitas no menu Configurações da visualização são salvas, e o link não é alterado.

Há alguns pontos a serem considerados sobre como as visualizações do SQL Runner funcionam:

  • A tabela de resultados e a visualização interpretam qualquer campo numérico como uma medida.
  • O nome completo do campo sempre é usado na tabela e na visualização de resultados. Portanto, a opção Mostrar nome completo do campo no menu Configurações está inativa.
  • Para usar campos personalizados, cálculos de tabela, tabelas dinâmicas, totais de colunas e subtotais, explore a partir da consulta do SQL Runner.
  • As visualizações de mapas estáticos (regiões) não são compatíveis com as visualizações do SQL Runner, mas os mapas que usam dados de latitude e longitude (visualizações de mapa e mapa estático (pontos)) são compatíveis.
  • As visualizações de linha do tempo não são compatíveis com as visualizações do SQL Runner.

Dimensões de rotação

É possível editar os resultados da consulta para pivot por uma ou mais dimensões nas visualizações do SQL Runner. Para dinamizar um campo:

  1. Selecione o menu de engrenagem de uma coluna na área Resultados para expor as opções da coluna.
  2. Selecione Coluna dinâmica.

Os resultados dinamizados são exibidos na visualização do SQL Runner.

Os resultados da área Resultados não aparecem dinamizados.

Para desmarcar os resultados, selecione o menu de engrenagem da coluna dinâmica e clique em Unpivot Column.

Como mudar o tipo de campo

Ao exibir os resultados e a visualização da consulta, o SQL Runner interpreta automaticamente qualquer campo numérico como uma medida e qualquer campo não numérico como uma dimensão. Para substituir o tipo de campo padrão e converter uma dimensão em uma medida, ou vice-versa, siga estas etapas:

  1. Selecione o menu de engrenagem de uma coluna na área Resultados para expor as opções da coluna.
  2. Selecione Converter em dimensão ou Converter em medição para mudar o tipo de campo.

A visualização vai mostrar o novo tipo de campo.

Como executar uma consulta em um modelo do LookML

É possível usar o SQL Runner para escrever e executar consultas SQL em um modelo LookML, em vez de diretamente no banco de dados. Ao criar sua consulta em um modelo, é possível usar operadores de substituição do LookML, como ${view_name.field_name} ou ${view_name.SQL_TABLE_NAME}. Isso pode economizar tempo ao criar uma consulta para resolver problemas de uma tabela derivada, por exemplo.

O Looker resolve todas as substituições do LookML e transmite a consulta ao banco de dados. Assim, a consulta precisa estar em SQL válido para o dialeto do banco de dados. Por exemplo, cada dialeto tem funções SQL ligeiramente diferentes com parâmetros específicos que devem ser passados para a função.

Para executar uma consulta no modelo LookML no SQL Runner:

  1. Selecione a guia Modelo.
  2. Selecione o modelo que você quer consultar.
  3. Na caixa de texto abaixo da barra Dados, insira sua consulta SQL usando os campos do LookML.
  4. Também é possível selecionar uma visualização na lista de visualizações para incluí-la na consulta na localização do cursor.
  5. Para ver a lista de campos em uma visualização, selecione-a na seção Visualizações. Opcionalmente, é possível selecionar um campo na lista de campos para incluí-lo na consulta no local do cursor.
  6. Na área Consulta SQL preparada, é possível visualizar a consulta SQL resultante, criada após a conversão de qualquer substituição do LookML em SQL.
  7. Selecione Executar para executar a consulta no seu modelo.
  8. Confira os resultados na área Resultados. O SQL Runner carrega até 5.000 linhas do conjunto de resultados da consulta. Para dialetos SQL compatíveis com streaming, é possível fazer o download dos resultados para ver todo o conjunto de resultados.

Use o SQL Runner para testar novas consultas, testar consultas existentes ou abrir uma nova Análise nos resultados. O destaque de erros do SQL Runner ajuda a testar e depurar consultas.

Quando quiser, é possível compartilhar a consulta e até mesmo adicioná-la a um projeto do LookML.

Como exibir o LookML de um campo no SQL Runner

Na lista de campos da guia Modelo, também é possível conferir um campo no LookML. Passe o cursor sobre o campo na lista de campos e selecione o ícone do Looker à direita do nome do campo.

O Looker abre o IDE do LookML e carrega o arquivo em que o campo está definido.

Histórico do SQL Runner

Também é possível conferir o histórico recente de todas as consultas executadas no SQL Runner.

Para ver seu histórico, selecione a guia Histórico na parte superior do painel de navegação. O SQL Runner exibe todas as consultas que foram executadas na conexão do banco de dados. Vermelho indica uma consulta que não foi executada devido a um erro.

Selecione uma consulta no histórico para preenchê-la no SQL Runner e selecione Executar para executá-la novamente.

Como classificar sua consulta

A ordem de classificação de uma tabela é indicada por uma seta para cima ou para baixo ao lado do nome do campo classificado, dependendo se os resultados estão em ordem crescente ou decrescente. Você pode classificar por várias colunas mantendo pressionada a tecla Shift e, em seguida, selecionando os cabeçalhos das colunas na ordem que deseja classificá-los. A ordem de classificação de um campo também é indicada por um número que distingue sua ordem de classificação em comparação com outros campos, por uma seta ao lado do nome do campo que mostra a direção de classificação (crescente ou decrescente) e por um pop-up que aparece quando você passa o mouse sobre o nome de um campo.

Para mais informações e exemplos, consulte a seção Como classificar dados na página de documentação Como analisar dados no Looker.

Compartilhamento de consultas

É possível compartilhar uma consulta no SQL Runner com outro usuário que tenha acesso ao SQL Runner. Para compartilhar uma consulta, copie o URL na barra de endereço do seu navegador.

Fazendo o download dos resultados

Depois de executar a consulta SQL, será possível fazer o download dos resultados em vários formatos.

  1. Escreva uma consulta na caixa Consulta SQL. Não é necessário executar a consulta no SQL Runner neste momento.
  2. Selecione Fazer o download no menu de engrenagem no canto superior direito.
  3. Selecione o formato de arquivo do download (arquivo de texto, CSV, JSON etc.).

  4. Selecione Abrir no navegador para conferir os resultados em uma nova janela do navegador ou selecione Fazer o download para salvar os resultados em um arquivo no computador.

    Quando você seleciona Abrir no navegador ou Fazer download, o Looker executa novamente a consulta e faz o download.

Para dialetos SQL compatíveis com streaming, a opção Download do SQL Runner faz o download de todo o conjunto de resultados. Para dialetos SQL não compatíveis com streaming, a opção Download do SQL Runner faz o download apenas das linhas da consulta mostradas na seção Resultados (até 5.000 linhas).

Como copiar valores de coluna

É possível copiar valores de coluna da seção Resultados no SQL Runner. Selecione o menu de engrenagem de uma coluna para copiar os valores para a área de transferência. A partir daí, você pode colar os valores da coluna em um arquivo de texto, uma planilha do Excel ou em outro local.

Se o administrador do Looker tiver ativado o recurso Labs do SQL Runner Vis, você também terá outras opções no menu de engrenagem da coluna:

Também é possível mover, fixar e resize manualmente as colunas na tabela de resultados.

Estimativas de custo para consultas do SQL Runner

Para conexões do BigQuery, MySQL, Amazon RDS para MySQL, Snowflake, Amazon Redshift, Amazon Aurora, PostgreSQL, Cloud SQL para PostgreSQL e Microsoft Azure PostgreSQL, o SQL Runner fornece uma estimativa do custo da consulta. Depois de inserir a consulta SQL, o SQL Runner calculará a quantidade de dados que a consulta exigirá e exibirá as informações ao lado do botão Executar.

Para conexões do BigQuery, MySQL e Amazon RDS para MySQL, as estimativas de custo estão sempre ativadas. Para conexões de banco de dados do Snowflake, Amazon Redshift, Amazon Aurora, PostgreSQL, Cloud SQL para PostgreSQL e Microsoft Azure PostgreSQL, você precisa ativar a opção Estimativa de custo para a conexão. É possível ativar a Estimativa de custo ao criar a conexão. Para as conexões atuais, é possível editar a conexão na página Conexões da seção Banco de dados do painel Administrador do Looker.

Como criar uma Análise ad hoc

Com o SQL Runner, é possível ter insights rápidos sobre os dados criando uma Análise ad hoc para uma consulta SQL ou tabela de banco de dados. É possível usar a Análise do Looker para selecionar campos, adicionar filtros, visualizar os resultados e criar consultas SQL.

Há duas maneiras de abrir uma Análise ad hoc no SQL Runner:

  • Explorar os resultados da consulta do SQL Runner
  • Explorar na lista de tabelas do SQL Runner

Como analisar os resultados da consulta do SQL Runner

O SQL Runner permite abrir uma Análise a partir de uma consulta SQL. Isso cria uma Análise temporária na consulta gravada no SQL Runner. Isso permite testar o que é retornado pela consulta e visualizar os resultados. Isso pode ser usado para qualquer consulta, mas é especialmente útil para testar as consultas que você planeja usar para tabelas derivadas.

Se o administrador do Looker tiver ativado o recurso Labs do SQL Runner Vis, será possível criar visualizações diretamente no SQL Runner.

  1. Use o SQL Runner para criar a consulta SQL que você quer usar.
  2. Selecione Explorar no menu de engrenagem no canto superior direito. Isso leva você a uma nova Análise, em que é possível explorar a consulta SQL como se fosse uma tabela salva no seu modelo.
  3. Você pode copiar o URL desta Análise para compartilhar.
  4. Para adicionar essa consulta como uma tabela derivada diretamente em seu projeto, selecione Adicionar visualização ao projeto.

Como criar campos personalizados durante a exploração no SQL Runner

Se você tiver acesso ao recurso de campos personalizados, poderá usá-los para visualizar campos não modelados no SQL Runner. Conforme descrito na seção anterior, selecione Explorar no menu de engrenagem. No seletor de campo, siga estas etapas:

Como explorar uma tabela listada no SQL Runner

Use a opção Explore Table na guia Database para criar uma Análise ad hoc para qualquer tabela na conexão. Assim, é possível usar o Looker em uma tabela antes de fazer a modelagem, analisando a tabela como uma visualização do LookML.

Depois de abrir uma Análise para a tabela, você pode decidir se quer adicioná-la ao seu projeto. Também é possível usar a guia SQL do Explore para ver as consultas SQL que o Looker envia para o banco de dados e, em seguida, usar o botão Abrir no SQL Runner para trazer a consulta de volta ao SQL Runner.

  1. Selecione a guia Banco de dados.
  2. No SQL Runner, selecione a engrenagem de uma tabela e clique em Explore Table.
  3. O Looker gera um modelo temporário com uma visualização da tabela e depois exibe a Análise.
  4. O Looker fornece um campo de dimensão para cada coluna na tabela. É da mesma forma que o Looker gera um modelo no início de um projeto.
  5. O Looker inclui automaticamente prazos para qualquer campo de data.
  6. O Looker também inclui uma medição de contagem.

Ao usar a opção Explore Table, nenhum arquivo LookML está associado a Explore, apenas uma visualização ad hoc da tabela.

Como depurar com o SQL Runner

O SQL Runner também é uma ferramenta útil para verificar erros SQL em consultas.

Destaque de erro do SQL Runner

O SQL Runner destaca o local dos erros no comando SQL e inclui a posição do erro na mensagem:

As informações de posição fornecidas variam dependendo do dialeto do banco de dados. Por exemplo, o MySQL fornece o número da linha que contém o erro, enquanto o Redshift informa a posição do caractere do erro. Outros dialetos de banco de dados podem ter um desses ou outros comportamentos.

O SQL Runner também destaca a localização do primeiro erro de sintaxe no comando SQL, sublinhando-o em vermelho e marcando a linha com um x. Mantenha o ponteiro do mouse sobre o x para ver mais informações sobre o erro. Depois de corrigir o problema, selecione Executar para conferir se há mais erros na consulta.

Como usar o SQL Runner para verificar erros em "Análises"

Se você encontrar erros de sintaxe SQL em uma Análise, use o SQL Runner para determinar o local e o tipo do erro, como erros de ortografia ou comandos ausentes.

  1. Em "Explore", selecione a guia SQL da barra de dados.
  2. Selecione Abrir no SQL Runner para abrir a consulta no SQL Runner.

O SQL gerado pela Análise é copiado para o SQL Runner. Conforme mostrado na seção Destaque de erro do SQL Runner, o SQL Runner destaca a localização dos erros no comando SQL e inclui a posição do erro na mensagem. É possível fazer alterações e executar novamente a consulta no SQL Runner até corrigir os erros.

Como usar o SQL Runner para verificar erros em tabelas derivadas

Para saber como usar o SQL Runner para verificar erros de SQL em tabelas derivadas, consulte a postagem Como usar o SQL Runner para testar tabelas derivadas da Comunidade do Looker.