Sherloq: совместная платформа для управления и обмена SQL-запросами непосредственно в редакторе

Общее введение

Sherloq - это инструмент для совместной работы с SQL, созданный для команд, работающих с данными, с основной функциональностью, позволяющей пользователям сохранять, управлять и делиться запросами непосредственно в существующих редакторах SQL. Он был разработан компанией SherloqData Ltd., которая была основана в 2022 году и имеет штаб-квартиру в Тель-Авиве, Израиль, а также офис в Сан-Франциско. Платформа централизует SQL-запросы, разбросанные по документам, Slack или Notepad, в общее хранилище с помощью плагинов, управляемых искусственным интеллектом. Sherloq поддерживается Y Combinator (партия W23) и получила посевной раунд в размере 500 000 долларов в 2023 году. Он идеально подходит для аналитиков данных и инженеров, сокращая дублирование усилий и улучшая совместную работу команды.

Список функций

• Сохранение и совместное использование SQL-запросов: Сохраните запрос прямо в редакторе и поделитесь им с командой одним щелчком мыши.
• Автоматическое создание документов: AI автоматически генерирует имена и описания для запросов и записывает историю версий.
• Сниппеты кода и шаблоны: Предоставляет многократно используемые фрагменты SQL, которые можно вставить в редактор и использовать.
• Функция поиска запросов: Поддерживает поиск записей индивидуальных или командных запросов по ключевым словам.
• Отслеживание истории: Просматривайте историю всех запросов команды и извлекайте ее, даже если она не была сохранена вручную.
• управление правамиУстановка разрешений на просмотр и редактирование папок и запросов с возможностью назначения их отдельным лицам или группам.
• Обеспечение безопасности данных: Не подключается к базе данных, обрабатывает метаданные только в редакторе и поддерживает соответствие стандарту SOC2.

Использование помощи

Как начать работу с Sherloq

Sherloq работает как плагин, что избавляет от необходимости сложной интеграции. Вот подробные шаги:

1. Получение и установка плагинов

• Нажмите на кнопку "Получить бесплатное расширение" или "Загрузить".
• Выберите версию плагина в соответствии с вашим редактором:
  • Расширение Chrome: для Snowflake, BigQuery, Databricks и других облачных редакторов перейдите по ссылке Магазин Chrome Скачать.
  • Плагин для IntelliJ: для DataGrip, PyCharm и других IDE от JetBrains перейдите по ссылке Рынок плагинов JetBrains Скачать.
  • VSCode Plugin: Бета-версия доступна и может быть загружена прямо с официального сайта.
• После загрузки следуйте подсказкам для установки и войдите в свою учетную запись Sherloq (для регистрации требуется электронная почта).

2. Настройки инициализации

• Откройте редактор SQL, и плагин автоматически отобразит экран приветствия.
• Выберите режим интерфейса (яркий или темный, официально пользователи 65% выбирают яркий).
• Нажмите "Продолжить", чтобы завершить инициализацию. sherloq не нужно обращаться к базе данных, он только считывает запрос из редактора.
• После инициализации плагин отображает панель администратора справа или снизу от редактора.

3. Руководство по эксплуатации основных функций

Сохраняйте и делитесь запросами

• Напишите SQL-запрос в редакторе и нажмите кнопку "Сохранить" в плагине.
• Введите название запроса (необязательное описание) и выберите "Поделиться с командой" или сделайте его приватным.
• После сохранения запрос будет синхронизирован с общим хранилищем команды и может быть просмотрен или использован непосредственно другими участниками.
• Чтобы поделиться, щелкните правой кнопкой мыши на запросе, выберите "Поделиться", и члены команды получат уведомление.

Поисковый запрос

• Введите ключевое слово (например, название таблицы "users_v2" или поле "revenue") в поле поиска на панели плагина.
• Система отображает соответствующий запрос, который можно загрузить в редактор и запустить, щелкнув по нему.
• По официальным данным, пользователи 26% часто ищут названия полей, и эта функция пользуется особой популярностью.

Использование фрагментов кода

• Просмотрите существующие сниппеты на вкладке "Сниппеты".
• Щелкните на клипе, чтобы вставить его прямо в редактор, где его можно быстро изменить для последующего использования.
• Подходит для повторяющихся запросов, таких как часто используемое условие CASE WHEN.

Посмотреть историю

• На вкладке "История" просмотрите историю запросов, сделанных вами или вашей командой.
• Несохраненные запросы также можно получить и восстановить одним щелчком мыши.
• Поддерживает фильтрацию по времени или пользователю для удобства отслеживания.

4. Описание работы специальных функций

Автоматическое создание документов

• Когда вы сохраняете запрос, ИИ автоматически генерирует краткое название и описание.
• Нажмите на "Документация", чтобы просмотреть полный текст записи, с поддержкой экспорта в Markdown или PDF.
• Это поможет новым участникам начать работу или передать знания.

контроль версий

• После редактирования запроса нажмите "История версий", чтобы просмотреть каждое изменение.
• Вы можете откатиться к любой версии или сравнить различия (похоже на Git, но проще).
• Подходит для запросов с частыми корректировками, например, для изменения поля с "revenue" на "revenue_new".

Разрешения и сотрудничество

• Назначьте права доступа к папкам или запросам в настройках "Разрешения".
• Можно установить режим "только просмотр" или "редактируемый" для поддержки распределения по командам.
• Нажмите "Деятельность", чтобы посмотреть, кто просматривал или редактировал запрос, и убедиться, что вы используете последнюю версию.

5. практические советы

• (компьютерная) клавиша быстрого доступа: По умолчанию Ctrl+S - сохранение, Ctrl+F - поиск, можно настроить в Настройках (общие сочетания клавиш для пользователей 73%).
• управление категориями: Организуйте запросы в папках и ярлыках, например, по проектам или лучшим практикам.
• Эффективность: Просматривайте пики запросов команды (11 утра, 2 часа дня, 3 часа дня) в "Озарениях", чтобы оптимизировать время совместной работы.

6. примеры сценариев использования

• Сцена 1: Босс хочет проверить данные о продажах за прошлый месяц. Вы открываете Sherloq, находите старый запрос в Истории, и все готово за 5 минут.
• Сцена 2: Новая задача по анализу таблицы users. Вы ищете "users_v2" и используете запрос своего коллеги, избавляя себя от необходимости переписывать его.

7. Оговорки

• Sherloq не трогает данные, а только содержимое редактора, и соответствует стандартам безопасности SOC2.
• Если плагин не загружается, проверьте сеть или обратитесь в службу поддержки (hello@sherloqdata.io).
• Рекомендуется регулярно проверять обновления, а официальный сайт предлагает как бесплатную версию, так и платный тарифный план (за превышение количества запросов или пользователей взимается плата).

Sherloq - это "помощник по запросам" для вашей команды разработчиков данных, который значительно сокращает время, затрачиваемое на управление SQL. Он прост в использовании и идеально подходит для ежедневного выполнения специальных запросов.