Sherloq: uma plataforma colaborativa para gerenciar e compartilhar consultas SQL diretamente no editor

Introdução geral

Sherloq é uma ferramenta de colaboração SQL criada para equipes de dados, com funcionalidade central que permite aos usuários salvar, gerenciar e compartilhar consultas diretamente nos editores SQL existentes. Ela foi desenvolvida pela SherloqData Ltd., fundada em 2022 e com sede em Tel Aviv, Israel, e um escritório em São Francisco. A plataforma centraliza as consultas SQL espalhadas por documentos, Slack ou Bloco de Notas em um repositório compartilhado por meio de plug-ins orientados por IA. A Sherloq é apoiada pela Y Combinator (lote W23) e recebeu uma rodada de sementes de US$ 500.000 em 2023. É ideal para analistas de dados e engenheiros, reduzindo a duplicação de esforços e melhorando a colaboração da equipe.

Lista de funções

• Salvamento e compartilhamento de consultas SQLSalvar a consulta diretamente no editor e compartilhá-la com a equipe em um clique.
• Geração automática de documentosIA: gera automaticamente nomes e descrições para consultas e registra o histórico de versões.
• Trechos de código e modelosSQL reutilizável: fornece fragmentos de SQL reutilizáveis que podem ser inseridos no editor e usados.
• Função de pesquisa de consultasPesquisa de registros de consultas individuais ou de equipes por palavras-chave: suporta a pesquisa de registros de consultas individuais ou de equipes por palavras-chave.
• Rastreamento de históricoHistórico de consultas: visualize todo o histórico de consultas da equipe e recupere-as mesmo que não tenham sido salvas manualmente.
• gerenciamento de direitosPermissões de visualização e edição de pastas e consultas: defina permissões de visualização e edição para pastas e consultas, com a flexibilidade de atribuí-las a indivíduos ou equipes.
• Garantia de segurança de dadosNão se conecta a um banco de dados, lida apenas com metadados no editor e oferece suporte à conformidade com SOC2.

Usando a Ajuda

Como começar a usar a Sherloq

O Sherloq é executado como um plug-in e não requer integração complexa. Aqui estão as etapas detalhadas:

1. obter e instalar plug-ins

• Clique no botão "Get Free Extension" ou "Download".
• Escolha a versão do plug-in de acordo com seu editor:
  • Extensão do Chrome: para Snowflake, BigQuery, Databricks e outros editores de nuvem, acesse Loja do Chrome Faça o download.
  • Plug-in IntelliJ: para DataGrip, PyCharm e outros IDEs da JetBrains, acesse Mercado de plug-ins da JetBrains Faça o download.
  • VSCode Plugin: a versão beta está disponível e pode ser baixada diretamente do site oficial.
• Após o download, siga as instruções para instalar e fazer login na sua conta Sherloq (é necessário um e-mail para o registro).

2. configurações de inicialização

• Abra seu editor SQL e o plug-in exibirá automaticamente a tela de boas-vindas.
• Selecione o modo de interface (claro ou escuro, oficialmente os usuários do 65% selecionam claro).
• Clique em "Continue" (Continuar) para concluir a inicialização. O sherloq não precisa acessar o banco de dados, mas apenas ler a consulta do editor.
• Após a inicialização, o plug-in exibe um painel de administração à direita ou na parte inferior do editor.

3. diretrizes para a operação das principais funções

Salvar e compartilhar consultas

• Escreva a consulta SQL no editor e clique no botão "Save" (Salvar) no plug-in.
• Digite um nome de consulta (descrição opcional) e selecione "Share with Team" (Compartilhar com a equipe) ou torne-a privada.
• Depois de salva, a consulta será sincronizada com o repositório compartilhado da equipe e poderá ser visualizada ou usada diretamente por outros membros.
• Para compartilhar, clique com o botão direito do mouse na consulta, selecione "Share" (Compartilhar) e os membros da equipe serão notificados.

Consulta de pesquisa

• Digite uma palavra-chave (por exemplo, o nome da tabela "users_v2" ou o campo "revenue") na caixa de pesquisa do painel do plug-in.
• O sistema exibe a consulta relevante, que pode ser carregada no editor e executada com um clique.
• Dados oficiais afirmam que os usuários do 26% costumam pesquisar nomes de campos, e esse recurso é particularmente popular.

Uso de snippets de código

• Procure os snippets existentes na guia Snippets.
• Clique em um clipe para inseri-lo diretamente no editor, onde ele pode ser modificado rapidamente para uso posterior.
• Adequado para consultas repetitivas, como a condição CASE WHEN comumente usada.

Ver histórico

• Na guia "History" (Histórico), veja o histórico das suas consultas ou das consultas da sua equipe.
• As consultas não salvas também podem ser recuperadas e restauradas com um único clique.
• Suporta filtragem por tempo ou usuário para facilitar o rastreamento.

4. descrição da operação dos recursos especiais

Geração automática de documentos

• Quando você salva uma consulta, a IA gera automaticamente um nome curto e uma descrição.
• Clique em "Documentation" (Documentação) para visualizar o registro completo, com suporte para exportação para Markdown ou PDF.
• Isso é útil para que novos membros comecem a trabalhar ou para que o conhecimento seja transmitido.

controle de versão

• Depois de editar a consulta, clique em "Version History" (Histórico da versão) para visualizar cada alteração.
• Você pode reverter para qualquer versão ou comparar diferenças (semelhante ao Git, mas mais fácil).
• Adequado para consultas com ajustes frequentes, como a alteração de um campo de "revenue" para "revenue_new".

Permissões e colaboração

• Atribua direitos de acesso a pastas ou consultas nas configurações de "Permissões".
• Pode ser definido como "somente visualização" ou "editável" para dar suporte à distribuição por equipe.
• Clique em "Activities" (Atividades) para ver quem visualizou ou editou a consulta e verifique se você está usando a versão mais recente.

5. dicas práticas

• Tecla de atalho (computador)Ctrl+S padrão para salvar, Ctrl+F para pesquisar, pode ser personalizado em Settings (atalhos comuns para usuários do 73%).
• gerenciamento de categoriasOrganize as consultas em pastas e rótulos, por exemplo, por projeto ou prática recomendada.
• Insights de eficiênciaVisualização dos picos de consulta da equipe (11h, 14h, 15h) em "Insights" para otimizar o tempo de colaboração.

6. exemplos de cenários de uso

• Cena 1O chefe quer verificar os dados de vendas do mês passado. Você abre o Sherloq, localiza a consulta antiga no Histórico e termina em 5 minutos.
• Cena 2: Nova tarefa para analisar a tabela de usuários. Você pesquisa "users_v2" e reutiliza a consulta do seu colega, poupando-o do trabalho de reescrevê-la.

7. advertências

• A Sherloq não mexe nos dados, apenas no conteúdo do editor, e está em conformidade com os padrões de segurança SOC2.
• Se o plug-in não for carregado, verifique a rede ou entre em contato com o suporte (hello@sherloqdata.io).
• Recomenda-se verificar regularmente se há atualizações, e o site oficial oferece uma versão gratuita e um plano pago (aplicam-se taxas se o número de consultas ou usuários for excedido).

O Sherloq é como um "assistente de consulta" para a sua equipe de dados, reduzindo drasticamente o tempo gasto no gerenciamento de SQL. É fácil de usar e é perfeito para cenários de consulta ad-hoc cotidianos.