それなら私はDataGripを使う
この記事は、 PLEX Advent Calendar 2024 の 2 日目の記事です。
はじめに
同じチームの同僚が、PLEX Advent Calendar 2024 の 1 日目に「【DB クライアントツール論争】それでも俺は DBeaver を使う」という記事を書いてくれました 🙏
記事では DBeaver という DB クライアントツールが紹介されており、私も布教されましたが元々使っていて馴染みのあった DataGrip を今も使い続けています。
個人的には DataGrip もおすすめなので、普段私が使っている機能を中心に紹介しつつ私が DataGrip を使い続ける理由をお伝えできたらと思います！
DataGrip とは
JetBrains 社が提供している DB クライアントツールです。
JetBrains 社は IntelliJ IDEA をはじめとした様々な言語の統合開発環境 (IDE) を提供しており、その中のひとつが DataGrip です。
DataGrip は、PostgreSQL や MySQL、Oracle など複数のデータベースに対応しており、最近では AI アシスタントが追加されるなど、開発に必要な便利な機能が充実しています。
簡単な紹介が済んだところで、次に DataGrip でよく使うショートカットやおすすめの機能を紹介していきます。
よく使うショートカット
業務で JetBrains 社が提供している Ruby on Rails 用の IDE: RubyMine を使っていることもあり、ショートカットが共通しているのもメリットの一つだと感じています。
それも含め、よく使うショートカットを紹介します。
検索まわり
DataGrip の GUI 上で Shift を 2 回クリックする（Shift + Shift）と Search Everywhere という検索が使えます。
名前の通り、何でも検索できるので便利です。
私がよく使うのは、その中でも Database 検索（Сmd + O）でテーブル名を入力することで、目当てのテーブルをすぐに表示することができます。
クエリコンソールまわり
DataGrip では console_1、console_2 のように複数のコンソールを別タブで開いておくことができます。
新しいクエリコンソールを開くショートカットは、Сmd + Shift + L です。
クエリコンソール上で書いたクエリは Сmd+Enter で実行できます。
また、Сmd + Option + E でこれまで実行した クエリ の履歴が確認できます。
Paste ボタンを押すと、クエリがクエリコンソール上に貼り付けされます。
タブまわり
Сmd + Shift + W で今見ているタブ以外のタブを全て閉じれます。
基本タブは開きっぱなしなのですが、たまに整理したくなるときがあるので使っています。
そのほか
ほかにも便利なショートカットがたくさんあるので、興味がある方は下記のドキュメントに掲載されている、default keymap reference card (74 KB) を参照ください 👀
おすすめの機能
ダイアグラム（図表）
ここでは ER 図と実行計画の 2 つを紹介します。
ER 図
下記の画像だと分かりにくいですが、テーブルを右クリックして Diagrams -> Show Diagram でそのテーブルと関連性のあるものだけに絞ったものが見れます。
一方で、データベースで同様のことをすると、データベース内の全てのテーブルが対象となります。
実行計画
クエリコンソール上で実行計画を出した後に、Explain した結果を Diagrams で表示してくれます。
実行計画と合わせて確認することで、ネックになっているポイントの特定に役立ちます。
pg_dump、pg_restore
データのバックアップを取っておいたり、それをもとにリストアするのも DataGrip なら GUI 上で簡単にできます。
下記の画像ようにオプションを指定することで、特定のテーブルのみ対象とすることもできます。
pg_restore
pg_restore
おまけ：AI アシスタント
業務では使用していないですが、トライアルで AI アシスタントを使ってみました。
導入方法
DataGrip を使っている方はプラグインをインストールするだけで、7 日間トライアルが使えます。（2024 年 12 月 2 日時点）
データの利用範囲
AI アシスタントを使うにあたって、データの利用範囲が気になったので調べてみました。
公式ドキュメントでは下記のように書かれています。
When you use AI features, DataGrip needs to send your requests and pieces of your code to the LLM (Large Language Model) provider. Besides the prompts you type, it may send additional details, such as file types, frameworks used, and any other information that may be necessary for providing context to the LLM.
AI 機能を使用する場合、DataGrip はあなたのリクエストとコードの一部を LLM（大規模言語モデル）プロバイダに送信する必要があります。入力したプロンプトの他に、ファイルタイプ、使用したフレームワーク、LLM にコンテキストを提供するために必要なその他の情報などの詳細を送信することがあります。
In addition, DataGrip builds with the AI Assistant plugin perform opt-in collection of detailed data about the usage of AI features, including the full communication between you and the LLM (both text and code fragments). This data is kept strictly confidential and is used by JetBrains for product improvement purposes only. It is never shared with any external parties, and it will not be used for training any ML models that generate code or text, or revealed in any form to any other users. The option that controls detailed data collection can be found in the IDE Settings under Tools | AI Assistant | Data Sharing | Allow detailed data collection and is disabled by default.
さらに、DataGrip は AI アシスタントプラグインを使用して、あなたと LLM 間の完全な通信（テキストとコードフラグメントの両方）を含む、AI 機能の使用に関する詳細なデータをオプトインで収集します。このデータは厳重に管理され、JetBrains によって製品改良の目的でのみ使用されます。また、コードやテキストを生成する ML モデルのトレーニングに使用されたり、他のユーザーに公開されたりすることはありません。詳細なデータ収集を制御するオプションは、IDE 設定の「ツール｜ AI アシスタント｜データ共有｜詳細なデータ収集を許可」にあり、デフォルトでは無効になっています。
AI Assistant doesn't share or get access to the data in your database.
AI アシスタントがデータベースのデータを共有したり、アクセスしたりすることはありません。
内容を見ると、「ML モデルのトレーニングに使用されたり、他のユーザーに公開されたりすることはありません」とありますが、業務で使用する際は会社やチームの方針に従った方が良さそうです。
日本語化する
チャットが英語で返ってくるとつらいので日本語化しておきます 💦
設定の Tools->AI Assistant->Natural Language から AI アシスタントで使用する言語を指定できるので、チェックを入れて japanese と入力するだけで OK です。（Japanese や 日本語でも OK そう）
モデルの選択
2024 年 12 月 2 日時点で使えるモデルは、
- openai-gpt-4o
- openai-gpt-4
- google-chat-gemini-pro-1.5
- google-chat-gemini-flash-1.5
- openai-chat-gpt
でした。
今回の記事では openai-gpt-4o を使って検証を行っています。
Chat with AI
実行前にスキーマを正しくアタッチしておくと、下記の動画のように本や著者などテーブル名を明示的に指定しなくても正しい SQL を作成してくれました。
簡単なものだったとはいえすごい 😳
チャット上で作成されたクエリは、ボタンひとつでコンソール上にコピペできます。
また、実行計画も結果をコピペして一言添えるだけで内容を説明してくれます。
Use AI prompts to explain and refactor your code
クエリコンソール上でも AI アシスタントが使えます。
クエリを選択して右クリックして AI Actions -> Explain Code をすると、そのクエリの内容について説明してくれます。
同様に AI Actions -> Suggest Refactoring で、そのクエリのリファクタリング案を提示してくてます。
他にもクエリ実行時にエラーが出た場合、エラーの内容を説明してくれるほか、修正も行ってくれます。
さいごに
DataGrip の良さについて、思うままに書き連ねてみました。
もちろん、他のツールにはそれぞれの魅力があり、DataGrip にも賛否両論があるのは承知の上です。
それでも、私はその多機能性や JetBrains 製品との高い親和性、そして AI アシスタントのような先進的な機能を積極的に取り入れている DataGrip をこれからも使い続けたいと思います。
Discussion