Sherloq : une plateforme collaborative pour gérer et partager des requêtes SQL directement dans l'éditeur

Introduction générale

Sherloq est un outil de collaboration SQL conçu pour les équipes de données, avec des fonctionnalités de base qui permettent aux utilisateurs d'enregistrer, de gérer et de partager des requêtes directement dans les éditeurs SQL existants. Il a été développé par SherloqData Ltd. qui a été fondée en 2022 et dont le siège social se trouve à Tel Aviv, en Israël, avec un bureau à San Francisco. La plateforme centralise les requêtes SQL dispersées dans des documents, Slack ou Notepad dans un référentiel partagé via des plugins pilotés par l'IA.Sherloq est soutenu par Y Combinator (lot W23) et a reçu un tour d'amorçage de 500 000 dollars en 2023. Il est idéal pour les analystes de données et les ingénieurs, réduisant la duplication des efforts et améliorant la collaboration au sein de l'équipe.

Liste des fonctions

• Sauvegarde et partage de requêtes SQLLa recherche peut être enregistrée directement dans l'éditeur et partagée avec l'équipe en un seul clic.
• Génération automatique de documentsL'IA génère automatiquement des noms et des descriptions pour les requêtes et enregistre l'historique des versions.
• Extraits de code et modèles: Fournit des fragments SQL réutilisables qui peuvent être insérés dans l'éditeur et utilisés.
• Fonction de recherche des demandes de renseignementsRecherche par mots-clés : permet de rechercher des enregistrements de requêtes individuelles ou collectives par mots-clés.
• Suivi de l'historiqueLe système d'enregistrement des requêtes : il permet de visualiser l'historique de toutes les requêtes de l'équipe et de les retrouver même si elles n'ont pas été sauvegardées manuellement.
• gestion des droitsLes droits de visualisation et d'édition des dossiers et des requêtes peuvent être attribués à des personnes ou à des équipes.
• Assurance de la sécurité des donnéesIl ne se connecte pas à une base de données, ne traite que les métadonnées dans l'éditeur et prend en charge la conformité SOC2.

Utiliser l'aide

Comment démarrer avec Sherloq

Sherloq fonctionne comme un plugin, éliminant le besoin d'une intégration complexe. Voici les étapes détaillées :

1) Obtenir et installer des plug-ins

• Cliquez sur le bouton "Get Free Extension" ou "Download".
• Choisissez la version du plugin en fonction de votre éditeur :
  • Extension Chrome : pour Snowflake, BigQuery, Databricks et d'autres éditeurs en nuage, rendez-vous à l'adresse suivante Chrome Store Télécharger.
  • Plugin IntelliJ : pour DataGrip, PyCharm et d'autres IDE JetBrains, allez à JetBrains Plugin Marketplace Télécharger.
  • VSCode Plugin : La version Beta est disponible et peut être téléchargée directement depuis le site officiel.
• Une fois téléchargé, suivez les instructions d'installation et connectez-vous à votre compte Sherloq (email requis pour l'enregistrement).

2) Paramètres d'initialisation

• Ouvrez votre éditeur SQL et le plugin affichera automatiquement l'écran de bienvenue.
• Sélectionnez le mode d'interface (lumineux ou sombre, officiellement les utilisateurs de 65% choisissent lumineux).
• Cliquez sur "Continuer" pour terminer l'initialisation. sherloq n'a pas besoin d'accéder à la base de données, mais lit seulement la requête de l'éditeur.
• Après l'initialisation, le plugin affiche un panneau d'administration à droite ou en bas de l'éditeur.

3. les lignes directrices pour l'utilisation des fonctions principales

Sauvegarder et partager des requêtes

• Rédigez la requête SQL dans l'éditeur et cliquez sur le bouton "Enregistrer" dans le plugin.
• Saisissez un nom de requête (description facultative) et sélectionnez "Partager avec l'équipe" ou rendre la requête privée.
• Une fois enregistrée, la requête sera synchronisée avec le référentiel partagé de l'équipe et pourra être consultée ou utilisée directement par les autres membres.
• Pour partager, cliquez avec le bouton droit de la souris sur la requête, sélectionnez "Partager" et les membres de l'équipe en seront informés.

Requête de recherche

• Saisissez un mot-clé (par exemple le nom de la table "users_v2" ou le champ "revenue") dans le champ de recherche du panneau du plugin.
• Le système affiche la requête correspondante, qui peut être chargée dans l'éditeur et exécutée en cliquant dessus.
• Les données officielles indiquent que les utilisateurs du 26% recherchent souvent des noms de champs, et cette fonction est particulièrement populaire.

Utilisation d'extraits de code

• Parcourez les snippets existants dans l'onglet Snippets.
• Cliquez sur un clip pour l'insérer directement dans l'éditeur, où il peut être rapidement modifié en vue d'une utilisation ultérieure.
• Convient aux requêtes répétitives, telles que la condition CASE WHEN couramment utilisée.

Voir l'historique

• Dans l'onglet "Historique", vous pouvez consulter l'historique de vos requêtes ou de celles de votre équipe.
• Les requêtes non enregistrées peuvent également être récupérées et restaurées d'un simple clic.
• Il est possible de filtrer les données par heure ou par utilisateur pour faciliter la traçabilité.

4) Description du fonctionnement des caractéristiques spéciales

Génération automatique de documents

• Lorsque vous enregistrez une requête, l'IA génère automatiquement un nom court et une description.
• Cliquez sur "Documentation" pour consulter l'enregistrement complet, avec la possibilité d'exporter vers Markdown ou PDF.
• Cela permet aux nouveaux membres de se lancer ou de transmettre leurs connaissances.

contrôle des versions

• Après avoir modifié la requête, cliquez sur "Historique des versions" pour visualiser chaque modification.
• Vous pouvez revenir à n'importe quelle version ou comparer les différences (comme avec Git, mais plus facilement).
• Convient aux requêtes comportant des ajustements fréquents, comme la modification d'un champ de "revenu" à "revenu_nouveau".

Permissions et collaboration

• Attribuez des droits d'accès aux dossiers ou aux requêtes dans les paramètres "Permissions".
• Il peut être défini comme "visible uniquement" ou "modifiable" pour permettre la distribution par équipe.
• Cliquez sur "Activités" pour voir qui a consulté ou modifié la requête et vous assurer que vous utilisez la dernière version.

5. conseils pratiques

• Touche de raccourci (ordinateur)Ctrl+S par défaut pour enregistrer, Ctrl+F pour rechercher, peuvent être personnalisés dans les paramètres (raccourcis communs pour les utilisateurs du 73%).
• gestion des catégoriesLes demandes de renseignements sont classées dans des dossiers et des étiquettes, par exemple par projet ou par meilleure pratique.
• Perspectives d'efficacitéLes heures de pointe (11 heures, 14 heures, 15 heures) sont affichées dans "Insights" afin d'optimiser le temps de collaboration.

6. exemples de scénarios d'utilisation

• Scène 1Le patron veut vérifier les données de vente du mois dernier. Vous ouvrez Sherloq, vous trouvez l'ancienne requête dans l'historique et vous avez terminé en 5 minutes.
• Scène 2La nouvelle tâche consiste à analyser la table des utilisateurs. Vous recherchez "users_v2" et réutilisez la requête de votre collègue, ce qui vous évite de la réécrire.

7. mises en garde

• Sherloq ne touche pas aux données, seulement au contenu de l'éditeur, et se conforme aux normes de sécurité SOC2.
• Si le plugin ne se charge pas, vérifiez le réseau ou contactez l'assistance (hello@sherloqdata.io).
• Il est recommandé de vérifier régulièrement les mises à jour, et le site officiel propose à la fois une version gratuite et une formule payante (des frais s'appliquent en cas de dépassement du nombre de requêtes ou d'utilisateurs).

Sherloq est comme un "assistant de requête" pour votre équipe de données, réduisant considérablement le temps passé à gérer SQL. Il est facile à utiliser et parfait pour les scénarios quotidiens d'interrogation ad hoc.