 |
Resumo | O Discourse Data Explorer permite que você execute consultas SQL diretamente no seu banco de dados em tempo real, possibilitando relatórios de estatísticas atualizados ao minuto. |
 |
Guia de Instalação | Este plugin já vem incluído no núcleo do Discourse. Não há necessidade de instalar o plugin separadamente. |
Se você está procurando exemplos ou suporte para qualquer consulta personalizada, você pode encontrar muitos tópicos em nossa categoria #data-reporting sob a tag sql-query. Se não houver um que atenda às suas necessidades específicas, sinta-se à vontade para criar um novo tópico para pedir ajuda à comunidade.
Ajuda com Consultas
Hospedado por nós? Este plugin está disponível em nossos planos Business e Enterprise. Data Explorer | Discourse - Civilized Discussion
Após instalar o plugin, acesse /admin/plugins.
Clique no botão “Configurações” e ative data explorer enabled (Data Explorer habilitado), depois retorne e recarregue a página.
Deve haver agora uma aba na navegação empilhada chamada “Data Explorer”. Selecione-a ou acesse /admin/plugins/discourse-data-explorer, em seguida, use os botões +, Importar ou Executar para começar.
Consultas padrão
Em uma instalação nova, o Data Explorer já vem com várias consultas que podem ajudar você a obter insights sobre a atividade do seu fórum. Abra qualquer consulta e clique em Executar para testá-la.
Veja como são as consultas padrão.
Nota: As consultas padrão são carregadas a partir deste arquivo: discourse-data-explorer/lib/discourse_data_explorer/queries.rb at main · discourse/discourse-data-explorer · GitHub
Se você tiver uma consulta incrível que deseja que todos tenham, faça um PR como este aqui.
As consultas padrão não podem ser editadas. Sinta-se à vontade para copiar o SQL e colá-lo em uma nova consulta se desejar modificá-las.
Escrevendo consultas
Quando você clica em qualquer um dos botões Editar em uma visualização de consulta, ou inicia uma nova Consulta do Explorer, você verá uma tela como a abaixo:
As duas caixas superiores são o nome e a descrição da consulta. O nome é o que você seleciona na caixa suspensa, e a descrição deve ser usada para coisas como explicar o que colocar nos parâmetros da consulta ou para descrever quais dados estão sendo consultados.
O painel à esquerda é onde você escreve a consulta SQL. Há uma realce de sintaxe básico e verificação fornecidos.
Execução automática de consultas
Embora você sempre possa executar uma consulta clicando no botão Executar, você pode economizar tempo ao carregar uma consulta adicionando o parâmetro run à URL.
Por exemplo: /admin/plugins/discourse-data-explorer/queries/123?run
Quando este parâmetro é adicionado à URL, a consulta será executada assim que você carregar a página, então você não precisa clicar no botão Executar para ver os resultados. Isso é especialmente útil para consultas que você executa com frequência, permitindo que você as marque nos favoritos ou as adicione à sua barra lateral com o parâmetro run incluído para um relatório de um clique.
Importando consultas
Como exemplo, vamos importar uma que eu escrevi. Baixe este arquivo, depois abra a caixa de diálogo de importação e selecione o arquivo para upload ou cole a consulta na caixa de texto. Clique em Importar para salvá-la e depois clique em Executar para ver os resultados.
most-common-likers.dcquery (1).json (442 Bytes)
Parece que todos os desenvolvedores do Discourse gostam bastante uns dos outros 
Pesquisando por consultas
Se você acumulou muitas consultas incríveis, sem problema! A barra de pesquisa pode ajudar você a filtrar por títulos e descrições.
Permitir que grupos não administradores executem consultas
Você pode adicionar grupos específicos (incluindo moderadores) a uma consulta para conceder acesso a ela:
Após salvar, você pode encontrá-la na página do Grupo para aquele grupo específico na aba Relatórios:
Clique em qualquer consulta para abri-la e depois no botão Executar para ver os resultados. Você também pode marcar relatórios de grupo nos favoritos clicando no botão Favoritar.
Compartilhando consultas com parâmetros predefinidos
Se você incluiu parâmetros definidos pelo usuário em sua consulta, pode compartilhar um link para a consulta e incluir os parâmetros na URL para que eles sejam preenchidos automaticamente quando a página carregar.
Você deve incluir os parâmetros na URL neste formato params={"parameter_name":"value"}. Separe múltiplos parâmetros com vírgulas. Por exemplo:
discourse.example.com/g/meu-grupo/relatorios/6?params={"param1":"valor1","param2":"valor2"}
Combinado com o parâmetro run mencionado acima, você pode compartilhar um relatório com parâmetros predefinidos que é executado automaticamente ao ser carregado.
Limites de resultados e exportação de consultas
Com consultas grandes, você pode notar que há um limite no número de linhas que o Data Explorer exibirá. Por padrão, o limite é definido para 1000 linhas. Isso é para evitar que consultas excessivamente grandes diminuam ou perturbem o desempenho da sua instância do Discourse.
Se você deseja contornar esse limite, você tem algumas opções:
- Paginação: Você pode paginar seus resultados. Em vez de tentar retornar todos os resultados de uma vez, você pode escrever sua consulta para retornar um intervalo específico de resultados. Você pode então ajustar esse intervalo para visualizar diferentes seções dos seus dados. Isso não aumentará o limite, mas permitirá que você visualize todos os seus dados em seções.
- Aumentar o limite: Se você tiver acesso ao servidor do Discourse e estiver confortável em fazer alterações nas configurações do Discourse, pode aumentar o limite. No entanto, isso deve ser feito com cautela. Aumentar o limite pode sobrecarregar muito seu servidor se você não tiver cuidado, especialmente se vários usuários estiverem executando consultas grandes ao mesmo tempo.
- Baixar os Resultados: Você também tem a opção de baixar os resultados da consulta em vez de visualizá-los diretamente no Discourse clicando nos botões
JSONouCSVapós executar a consulta. Os dados baixados de uma consulta em formato JSON ou CSV terão um limite de resultados muito maior de 10.000 linhas. Para fins programáticos, você deve optar pelo formato JSON, ou, se quiser trabalhar com os dados em um aplicativo de planilha, o formato CSV pode ser mais conveniente.
É geralmente uma boa ideia tentar escrever consultas mais eficientes, ou filtrar seus dados para que você esteja recuperando apenas o que precisa, em vez de tentar contornar o limite.
Você também pode exportar a própria consulta SQL no formato .JSON clicando no botão Exportar. Consultas exportadas usando este método podem então ser importadas para outros sites do Discourse, ou usadas com aplicativos de terceiros.
Plano de consulta
A caixa de seleção “Incluir plano de consulta” pode ser usada para uma melhor compreensão e otimização de suas consultas SQL.
Quando você marca essa caixa e executa uma consulta, o Discourse exibirá a sequência de operações usadas para acessar os dados no banco de dados do Discourse. Isso pode incluir operações como varreduras, junções, ordenações e outras ações do banco de dados. Ao examinar o plano de consulta, você pode ver exatamente como o banco de dados está executando sua consulta.
A série de tutoriais do Data Explorer
Temos também uma série dedicada sql-tutorial sobre o Data Explorer! Se você está interessado em aprender mais sobre como escrever consultas SQL no Discourse, recomendamos altamente ler os tópicos nesta série: