Sherloq: una plataforma colaborativa para gestionar y compartir consultas SQL directamente en el editor

Introducción general

Sherloq es una herramienta de colaboración SQL creada para equipos de datos, con una funcionalidad básica que permite a los usuarios guardar, gestionar y compartir consultas directamente en los editores SQL existentes. Fue desarrollada por SherloqData Ltd., fundada en 2022 y con sede en Tel Aviv (Israel) y oficina en San Francisco. La plataforma centraliza las consultas SQL dispersas en documentos, Slack o Bloc de notas en un repositorio compartido a través de plugins impulsados por IA.Sherloq está respaldado por Y Combinator (lote W23) y recibió una ronda semilla de 500.000 dólares en 2023. Es ideal para analistas de datos e ingenieros, ya que reduce la duplicación de esfuerzos y mejora la colaboración en equipo.

Lista de funciones

• Guardar y compartir consultas SQLGuarda la consulta directamente en el editor y compártela con el equipo en un clic.
• Generación automática de documentosLa IA genera automáticamente nombres y descripciones para las consultas y registra el historial de versiones.
• Fragmentos de código y plantillas: Proporciona fragmentos SQL reutilizables que pueden insertarse en el editor y utilizarse.
• Función de búsqueda de consultas: Permite buscar registros de consulta individuales o de equipo por palabras clave.
• Seguimiento histórico: Visualiza todo el historial de consultas del equipo y recupéralo aunque no se haya guardado manualmente.
• gestión de derechos: Establezca permisos de visualización y edición para carpetas y consultas, con la flexibilidad de asignarlos a personas o equipos.
• Garantía de seguridad de los datos: No se conecta a una base de datos, sólo maneja metadatos en el editor y admite la conformidad SOC2.

Utilizar la ayuda

Cómo empezar a utilizar Sherloq

Sherloq se ejecuta como un plugin, eliminando la necesidad de una integración compleja. Aquí están los pasos detallados:

1. Obtención e instalación de plug-ins

• Haga clic en el botón "Obtener extensión gratuita" o "Descargar".
• Elija la versión del plugin según su editor:
  • Extensión de Chrome: para Snowflake, BigQuery, Databricks y otros editores en la nube, vaya a Tienda Chrome Descargar.
  • Plugin IntelliJ: para DataGrip, PyCharm y otros IDE de JetBrains, vaya a Mercado de plugins JetBrains Descargar.
  • Plugin VSCode: La versión beta está disponible y puede descargarse directamente desde el sitio web oficial.
• Una vez descargado, siga las instrucciones para instalarlo e inicie sesión en su cuenta de Sherloq (se requiere una dirección de correo electrónico para registrarse).

2. Ajustes de inicialización

• Abra su editor SQL y el plugin mostrará automáticamente la pantalla de bienvenida.
• Selecciona el modo de interfaz (brillante u oscuro, oficialmente los usuarios de 65% seleccionan brillante).
• Haga clic en "Continuar" para completar la inicialización. sherloq no necesita acceder a la base de datos, sino que sólo lee la consulta del editor.
• Tras la inicialización, el plugin muestra un panel de administración a la derecha o en la parte inferior del editor.

3. Directrices para el funcionamiento de las funciones principales

Guardar y compartir consultas

• Escriba la consulta SQL en el editor y haga clic en el botón "Guardar" del complemento.
• Introduzca un nombre para la consulta (descripción opcional) y seleccione "Compartir con el equipo" o hágala privada.
• Una vez guardada, la consulta se sincronizará con el repositorio compartido del equipo y podrá ser visualizada o utilizada directamente por otros miembros.
• Para compartir, haga clic con el botón derecho del ratón en la consulta, seleccione "Compartir" y los miembros del equipo recibirán una notificación.

Consulta de búsqueda

• Introduzca una palabra clave (por ejemplo, el nombre de la tabla "users_v2" o el campo "revenue") en el cuadro de búsqueda del panel de complementos.
• El sistema muestra la consulta pertinente, que puede cargarse en el editor y ejecutarse haciendo clic en ella.
• Según datos oficiales, los usuarios del 26% suelen buscar nombres de campos, y esta función es especialmente popular.

Uso de fragmentos de código

• Examine los fragmentos existentes en la pestaña Fragmentos.
• Haz clic en un clip para insertarlo directamente en el editor, donde podrás modificarlo rápidamente para su uso posterior.
• Adecuado para consultas repetitivas, como la condición CASE WHEN de uso común.

Ver historial

• En la pestaña "Historial", consulte el historial de sus consultas o las de su equipo.
• Las consultas no guardadas también pueden recuperarse y restaurarse con un solo clic.
• Admite el filtrado por hora o usuario para facilitar la trazabilidad.

4. Descripción del funcionamiento de las características especiales

Generación automática de documentos

• Al guardar una consulta, la IA genera automáticamente un nombre corto y una descripción.
• Haga clic en "Documentación" para ver el registro completo, con soporte para exportar a Markdown o PDF.
• Esto es útil para que los nuevos miembros se inicien o para transmitir conocimientos.

control de versiones

• Después de editar la consulta, haga clic en "Historial de versiones" para ver cada cambio.
• Puedes retroceder a cualquier versión, o comparar diferencias (similar a Git, pero más fácil).
• Adecuado para consultas con ajustes frecuentes, como cambiar un campo de "ingresos" a "ingresos_nuevos".

Permisos y colaboración

• Asigna derechos de acceso a carpetas o consultas en la configuración de "Permisos".
• Puede configurarse como "sólo visible" o "editable" para facilitar la distribución por equipos.
• Haz clic en "Actividades" para ver quién ha visto o editado la consulta y asegúrate de que estás utilizando la última versión.

5. Consejos prácticos

• Tecla de acceso directo (ordenador)Ctrl+S por defecto para guardar, Ctrl+F para buscar, se pueden personalizar en Configuración (atajos comunes para los usuarios del 73%).
• gestión por categorías: Organiza las consultas en carpetas y etiquetas, por ejemplo, por proyectos o buenas prácticas.
• Perspectivas de eficiencia: Visualiza los picos de consulta del equipo (11 AM, 2 PM, 3 PM) en "Insights" para optimizar el tiempo de colaboración.

6. Ejemplos de escenarios de uso

• Escena 1El jefe quiere consultar los datos de ventas del mes pasado. Abre Sherloq, busca la consulta antigua en Historial y acaba en 5 minutos.
• Escena 2Nueva tarea para analizar la tabla de usuarios. Buscas "usuarios_v2" y reutilizas la consulta de tu colega, lo que te ahorra tener que reescribirla.

7. Precauciones

• Sherloq no toca los datos, sólo el contenido del editor, y cumple las normas de seguridad SOC2.
• Si el plugin no se carga, compruebe la red o póngase en contacto con el servicio de asistencia (hello@sherloqdata.io).
• Se recomienda comprobar si hay actualizaciones con regularidad, y el sitio web oficial ofrece una versión gratuita y un plan de pago (se aplican tarifas por superar el número de consultas o usuarios).

Sherloq es como un "asistente de consultas" para su equipo de datos, que reduce drásticamente el tiempo dedicado a gestionar SQL. Es fácil de usar y perfecto para las consultas ad hoc cotidianas.