General Introduction
Sherloq 是一个专为数据团队打造的 SQL 协作工具,核心功能是让用户直接在现有 SQL 编辑器中保存、管理和共享查询。它由 SherloqData Ltd. 开发,公司成立于 2022 年,总部位于以色列特拉维夫,并在旧金山设有办公室。平台通过 AI 驱动的插件,将分散在文档、Slack 或记事本中的 SQL 查询集中到一个共享仓库中。Sherloq 获 Y Combinator(W23 批次)支持,并在 2023 年拿到 50 万美元种子轮融资。它适合数据分析师和工程师,能有效减少重复工作,提升团队协作效率。
Function List
- SQL 查询保存与共享:直接在编辑器中保存查询,并一键分享给团队。
- Automatic Document Generation:AI 自动为查询生成名称、描述,并记录版本历史。
- 代码片段与模板:提供可复用的 SQL 片段,插入编辑器即可使用。
- 查询搜索功能:支持按关键词搜索个人或团队的查询记录。
- 历史记录追踪:查看团队所有查询历史,即使未手动保存也能找回。
- Rights Management:设置文件夹和查询的查看与编辑权限,灵活分配给个人或团队。
- Data Security Assurance:不连接数据库,仅处理编辑器中的元数据,支持 SOC2 合规。
Using Help
如何开始使用 Sherloq
Sherloq 以插件形式运行,无需复杂集成。以下是详细步骤:
1. 获取与安装插件
- 点击“Get Free Extension”或“Download”按钮。
- 根据你的编辑器选择插件版本:
- Chrome 扩展:适用于 Snowflake、BigQuery、Databricks 等云端编辑器,前往 Chrome 商店 Download.
- IntelliJ 插件:适用于 DataGrip、PyCharm 等 JetBrains IDE,前往 JetBrains 插件市场 Download.
- VSCode 插件:Beta 版已推出,可从官网直接下载。
- 下载后,按提示安装并登录你的 Sherloq 账号(注册时需提供邮箱)。
2. 初始化设置
- 打开你的 SQL 编辑器,插件会自动显示欢迎界面。
- 选择界面模式(亮色或暗色,官方称 65% 用户选亮色)。
- 点击“Continue”完成初始化。Sherloq 不需访问数据库,仅读取编辑器中的查询内容。
- 初始化后,插件会在编辑器右侧或底部显示一个管理面板。
3. 主要功能操作指南
保存与共享查询
- 在编辑器中写好 SQL 查询,点击插件中的“Save”按钮。
- 输入查询名称(可选描述),选择“Share with Team”或设为私有。
- 保存后,查询会同步到团队共享仓库,其他成员可直接查看或使用。
- 要共享,右键查询,选择“Share”,团队成员会收到通知。
搜索查询
- 在插件面板的搜索框输入关键词(如表名“users_v2”或字段“revenue”)。
- 系统显示相关查询,点击即可加载到编辑器运行。
- 官方数据称,26% 用户常搜索字段名,这项功能特别受欢迎。
Using code snippets
- 在“Snippets”选项卡中浏览已有片段。
- 点击片段直接插入编辑器,可快速修改后使用。
- 适合重复性查询,如常用 CASE WHEN 条件。
View History
- 在“History”选项卡中,查看你或团队的历史查询。
- 未保存的查询也能找回,点击即可恢复。
- 支持按时间或用户筛选,方便追溯。
4. 特色功能操作说明
自动文档生成
- 保存查询时,AI 会自动生成简短名称和描述。
- 点击“Documentation”查看完整记录,支持导出为 Markdown 或 PDF。
- 这对新成员入门或知识传承很有帮助。
version control
- 编辑查询后,点击“Version History”查看每次变更。
- 可回滚到任一版本,或对比差异(类似 Git,但更简单)。
- 适合频繁调整的查询,比如字段从“revenue”改为“revenue_new”。
权限与协作
- 在“Permissions”设置中,为文件夹或查询分配访问权限。
- 可设为“仅查看”或“可编辑”,支持按团队分配。
- 点击“Activities”查看谁查看或编辑了查询,确保使用最新版本。
5. 实用技巧
- (computer) shortcut key:默认 Ctrl+S 保存,Ctrl+F 搜索,可在设置中自定义(73% 用户常用快捷键)。
- category management:用文件夹和标签整理查询,如按项目或最佳实践分类。
- 效率洞察:在“Insights”查看团队查询高峰(11 AM、2 PM、3 PM),优化协作时间。
6. 使用场景示例
- Scene 1:老板要查上月销售数据。你打开 Sherloq,在历史记录中找到旧查询,5 分钟搞定。
- Scene 2:新任务分析用户表。你搜索“users_v2”,复用同事的查询,省去重写麻烦。
7. Caveats
- Sherloq 不接触数据,仅处理编辑器内容,符合 SOC2 安全标准。
- 如插件加载失败,检查网络或联系支持(hello@sherloqdata.io)。
- 建议定期检查更新,官网提供免费版本和付费计划(超出查询数或用户数需付费)。
Sherloq 就像数据团队的“查询助手”,能大幅减少管理 SQL 的时间。它简单易用,特别适合日常临时查询的场景。