Tutorial do Explorador de Dados - Parte 1 - Escrevendo sua Primeira Consulta

:discourse: Quer extrair alguns dados do seu site Discourse, mas não sabe por onde começar? Você veio ao lugar certo! Este é um guia de tutorial para iniciantes que são novos no Explorador de Dados. Se você já está familiarizado com SQL e como usar o Explorador de Dados, então muito provavelmente não precisará ler este tópico e poderá conferir nossa categoria Data & reporting.

O objetivo deste guia é ajudá-lo a ter uma compreensão básica de como usar o Explorador de Dados para criar relatórios em seu site Discourse, e é a primeira parte de nossa série de Tutoriais do Explorador de Dados.

O que é o Explorador de Dados?

O Explorador de Dados é um plugin do Discourse que permite executar consultas SQL em seu banco de dados e exportar os resultados. É uma ferramenta poderosa para extrair e analisar dados do seu site Discourse.

Antes de poder usar o Explorador de Dados, você precisará instalá-lo em seu site. Veja Install plugins on a self-hosted site se precisar de alguma ajuda com isso.

:discourse: O Explorador de Dados é pré-instalado nos planos hospedados Business e Enterprise do Discourse.

Depois de instalar o Explorador de Dados, você pode começar a usá-lo para executar consultas SQL.

Criando nossa primeira Consulta SQL

A melhor maneira de se familiarizar com o Explorador de Dados é ter alguma experiência prática!

Vamos começar criando nossa primeira consulta:

  1. Vá para o admin em seu site e clique na aba Plugins.
  2. Encontre o plugin Data Explorer e clique nele.
  3. Clique no botão + para ver uma caixa de texto e um botão para criar uma nova consulta SQL.
  4. Digite o nome da sua consulta.
  5. Clique em Create New para criar a consulta.

A partir daqui, podemos começar a construir nossa primeira consulta.

A Página de Nova Consulta Padrão:

Hello World

Para nossa primeira consulta, vamos criar um relatório que nos mostrará: Os Tópicos Mais Vistos no Site :sparkles:

Pensando em como precisaremos criar isso, vamos começar selecionando os campos title e views da tabela topics:

SELECT
    title, views
FROM 
    topics

O que nos mostrará uma lista de todos os tópicos no site e o número de visualizações que eles têm. Clique em Run para ver isso em ação:

Ordenando Resultados

Olhando para esses resultados, você notará que eles não estão ordenados - isso ocorre porque precisamos usar explicitamente uma instrução ORDER BY para ordenar nossos resultados como desejado. Vamos adicionar isso agora:

SELECT
    title, views
FROM 
    topics
ORDER BY views DESC

Vamos clicar em Run novamente para ver o que mudou:

Aí está - nossos resultados agora estão ordenados em ordem descendente por visualizações!

Formatando Resultados

Com esta consulta, não seria bom se pudéssemos clicar diretamente no nome do tópico e ser levados a ele? Que bom que podemos fazer isso com Resultados de Tabela Formatados!

Vamos mudar a seção title de nossa consulta para id as topic_id para ver isso em ação:

SELECT
    id as topic_id,
    views
FROM 
    topics
ORDER BY views DESC

Agora os títulos dos tópicos são exibidos como hiperlinks!

:discourse: Os números que você está vendo ao lado do tópico são o número de respostas que o tópico tem.

Adicionando Parâmetros e instruções WHERE

Para nossa adição final à consulta, vamos modificar a consulta para que vejamos apenas tópicos com mais de X número de visualizações. Para fazer isso, precisaremos adicionar um parâmetro e uma instrução WHERE. Para nosso parâmetro, usaremos um int (inteiro), e a instrução WHERE filtrará os resultados para que apenas tópicos com mais do que o número mínimo de visualizações sejam exibidos.

-- [params]
-- int :min_views= 10

SELECT
    id as topic_id,
    views
FROM 
    topics
WHERE views > :min_views
ORDER BY views DESC

Ao executar esta consulta, você verá agora que há um parâmetro min_views que você pode usar para alterar o número mínimo de visualizações que os tópicos precisam ter para serem exibidos nos resultados.

Conclusão

Esperamos que você esteja começando a ter uma ideia de como as consultas do Explorador de Dados são construídas após passar por estas etapas, no entanto, mal arranhamos a superfície neste tópico!

O Explorador de Dados, e de forma mais geral, SQL é um assunto muito, muito amplo. Se você estiver interessado em aprender mais sobre o Explorador de Dados e Consultas SQL, recomendamos fortemente a leitura dos outros tópicos desta série.

Mais Tópicos Nesta Série

11 curtidas