はじめに
Sherloqはデータチーム向けに開発されたSQLコラボレーションツールで、既存のSQLエディタ内で直接クエリを保存、管理、共有できるコア機能を備えています。2022年に設立され、イスラエルのテルアビブに本社を置き、サンフランシスコにオフィスを構えるSherloqData Ltd.によって開発された。SherloqはY Combinator(W23バッチ)の支援を受けており、2023年に50万ドルのシードラウンドを受けた。データアナリストやエンジニアに最適で、重複作業を減らし、チームコラボレーションを向上させる。
機能一覧
- SQLクエリの保存と共有エディターで直接クエリを保存し、ワンクリックでチームと共有できます。
- ドキュメントの自動生成AIはクエリの名前と説明を自動的に生成し、バージョン履歴を記録する。
- コード・スニペットとテンプレートエディタに挿入して使用できる再利用可能なSQLフラグメントを提供します。
- お問い合わせ検索機能個人またはチームのクエリ記録をキーワードで検索できます。
- 歴史の追跡チームのクエリ履歴をすべて表示し、手動で保存していない場合でも検索できます。
- ライツ・マネジメントフォルダやクエリの閲覧・編集権限を設定し、個人またはチームに柔軟に割り当てることができます。
- データ・セキュリティ保証データベースには接続せず、エディターでメタデータを扱うのみ。
ヘルプの使用
Sherloqを始めるには
Sherloqはプラグインとして動作し、複雑な統合を必要としません。以下は詳細な手順です:
1.プラグインの入手とインストール
- Get Free Extension "または "Download "ボタンをクリックします。
- お使いのエディタに合わせてプラグインのバージョンを選択してください:
- Chrome拡張機能:Snowflake、BigQuery、Databricks、その他のクラウド・エディタについては、以下を参照。 クロームストア ダウンロード
- IntelliJプラグイン:DataGrip、PyCharm、その他のJetBrains IDEについては、以下を参照してください。 JetBrainsプラグインマーケットプレイス ダウンロード
- VSCodeプラグイン:ベータ版があり、公式サイトから直接ダウンロードできる。
- ダウンロードしたら、プロンプトに従ってインストールし、Sherloqアカウントにログインしてください(登録には電子メールが必要です)。
2.初期設定
- SQLエディタを開くと、プラグインは自動的にウェルカム画面を表示します。
- インターフェイスモード(明るいか暗いか、公式には65%ユーザーは明るい方を選択)を選択する。
- Continue」をクリックして初期化を完了します。sherloq はデータベースにアクセスする必要はなく、エディタからクエリを読み込むだけです。
- 初期化後、プラグインはエディタの右か下に管理パネルを表示します。
3.主な機能の操作に関するガイドライン
クエリーの保存と共有
- エディタでSQLクエリを書き、プラグインの "保存 "ボタンをクリックする。
- クエリ名(任意の説明)を入力し、「チームで共有」を選択するか、非公開にします。
- 一度保存されると、クエリはチーム共有リポジトリに同期され、他のメンバーが直接閲覧または使用することができます。
- 共有するには、クエリを右クリックし、「共有」を選択すると、チームメンバーに通知されます。
検索クエリ
- プラグインパネルの検索ボックスにキーワード(例:テーブル名 "users_v2 "またはフィールド "revenue")を入力する。
- システムは関連するクエリを表示し、それをクリックしてエディタに読み込み、実行する。
- 公式データによると、26%のユーザーはフィールド名を検索することが多く、この機能は特に人気があるという。
コード・スニペットの使用
- スニペットタブで既存のスニペットを参照します。
- クリップをクリックするとエディタに直接挿入され、後で使用するために素早く修正できます。
- よく使われる CASE WHEN 条件のような繰り返しクエリに適しています。
履歴を見る
- 履歴」タブで、あなたまたはあなたのチームのクエリの履歴を表示します。
- 未保存のクエリーもワンクリックで検索・復元が可能です。
- 時間やユーザーによるフィルタリングをサポートし、トレーサビリティを容易にします。
4.特別機能の動作説明
ドキュメントの自動生成
- クエリを保存すると、AIが自動的に短い名前と説明を生成します。
- Documentation "をクリックすると、MarkdownやPDFへのエクスポートに対応した全記録を見ることができます。
- 新メンバーの入門や知識の継承に役立つ。
バージョン管理
- クエリを編集した後、"Version History "をクリックして各変更を表示します。
- 任意のバージョンにロールバックしたり、差分を比較したりできる(Gitに似ているが、より簡単)。
- フィールドを "revenue "から "revenue_new "に変更するなど、頻繁に調整を行うクエリに適している。
パーミッションとコラボレーション
- アクセス権」の設定で、フォルダやクエリにアクセス権を割り当てます。
- チーム単位での配布をサポートするため、「閲覧のみ」または「編集可能」に設定可能。
- アクティビティ」をクリックし、誰がクエリを閲覧または編集したかを確認し、最新バージョンを使用していることを確認してください。
5.実践的なヒント
- (ショートカットキーデフォルトのCtrl+Sで保存、Ctrl+Fで検索、設定でカスタマイズ可能(73%ユーザー共通のショートカット)。
- カテゴリー管理プロジェクト別やベストプラクティス別など、フォルダやラベルでクエリーを整理。
- 効率性の洞察チームのクエリのピーク(午前11時、午後2時、午後3時)を「インサイト」で確認し、コラボレーション時間を最適化。
6.使用シナリオの例
- シーン1上司が先月の売上データを確認したいと言っている。Sherloqを開き、履歴から古いクエリを見つけ、5分で完了。
- シーン2usersテーブルを分析する新しいタスク。users_v2 "を検索し、同僚のクエリを再利用する。
7.注意事項
- Sherloqはデータには触れず、エディタコンテンツのみを扱い、SOC2セキュリティ基準に準拠しています。
- プラグインのロードに失敗した場合は、ネットワークを確認するか、サポート (hello@sherloqdata.io) に連絡してください。
- 定期的にアップデートをチェックすることが推奨されており、公式サイトでは無料版と有料プランの両方が提供されている(クエリー数やユーザー数を超えると料金が発生する)。
Sherloqはデータチームの「クエリアシスタント」のようなもので、SQLの管理に費やす時間を大幅に削減します。使いやすく、日常のアドホックなクエリシナリオに最適です。