DynoTable for JetBrains IDEs
DynoTable プラグインを使うと、JetBrains IDE で SQL、PartiQL、OpenSearch のクエリを書き、 DynoTable プロファイルのテーブルとインデックスに対して実行できます。IntelliJ IDEA、DataGrip、 WebStorm、PyCharm、GoLand、Rider など、言語サーバーに対応した JetBrains IDE で動作します。
同じコンピューター上の DynoTable デスクトップアプリが、実際のスキーマに基づく言語機能を提供し、クエリを実行します。クエリファイルと言語は DynoTable for VS Code と同じです。
必要なもの
- 言語サーバーに対応した JetBrains IDE のバージョン 2026.3 以降。
- 信頼済みのプロジェクト。
- 同じコンピューターにインストールされた DynoTable 1.19.0 以降。
- アプリでエディタ連携がオンになっていること。デフォルトはオフです。
リモート開発、WSL 内のプロジェクト、Light Edit モード、Android Studio には対応していません。プラットフォームを参照してください。
エディタ連携をオンにする
- DynoTable を開きます。
- 設定 → エディタ連携 に移動します。
- エディタ連携 をオンにします。
この操作は一度だけです。その後は、アプリが必要になるとプラグインが DynoTable を起動します。 DynoTable はバックグラウンドで動作するを参照してください。
プラグインをインストールする
- IDE で Settings → Plugins に移動します。
- Marketplace タブを開きます。
- DynoTable を検索して Install をクリックします。
JetBrains Marketplace のページからもインストールできます。
クエリファイル
| ファイル | ファイルタイプ | 言語 |
|---|---|---|
*.dynotable.sql | DynoTable SQL | DynoTable SQL(テーブルとインデックスが対象) |
*.partiql | DynoTable PartiQL | DynamoDB PartiQL |
*.opensearch | DynoTable OpenSearch | 1 つの OpenSearch クエリ: JSON クエリ DSL か Lucene |
DynoTable は、これらのファイルがスクラッチファイルの場合やプロジェクトの外にある場合も扱います。
New DynoTable Query は SQL、PartiQL、OpenSearch のどれにするかを尋ね、その言語の新しいクエリをスクラッチファイルとして開きます。
SQL ファイル
DynoTable はすべての .sql ファイルに接続するわけではありません。接続するのは、
*.dynotable.sql ファイルと、プロジェクトの SQL files 設定に一致するファイルです。
ほかの .sql ファイルを接続するには、そのファイルを開いて Tools → DynoTable → Attach SQL
File to DynoTable を実行します。このアクションは、ファイルをプロジェクトの SQL files
設定に追加します。接続できるのは、プロジェクト内の .sql ファイルだけです。開いているプロジェクトごとに、それぞれの SQL files 設定があります。
SQL ファイルでは DynamoDB のテーブルと OpenSearch のインデックスをクエリでき、1 つのステートメントでテーブルとインデックスを結合できます。 1 つの SQL ファイルで 2 つのエンジンを参照してください。
OpenSearch ファイル
OpenSearch クエリは、1 行目でインデックスを指定します:
// dynotable: index=orders
{"query": {"match": {"status": "shipped"}}}Pick OpenSearch Index を実行すると、一覧からインデックスを選べます。この行は自動で書き込まれます。
2 つの OpenSearch ターゲットに同じ名前のインデックスがある場合は、この行に
target=<target name> も必要です。DynoTable がすべてのターゲットのインデックスを一覧できなかった場合も必要です。
Pick OpenSearch Index とエクスプローラーの New DynoTable Query は、これも自動で追加します。スペースを含むターゲット名はこの行に書けません。
プロファイルを選ぶ
1 つの接続は 1 つの DynoTable プロファイルを使います。
- DynoTable にプロファイルが 1 つだけなら、プラグインはそれを使います。
- 複数ある場合は、Select DynoTable Profile を実行して 1 つ選びます。プロファイルを選んでいない間は、DynoTable のステータスバーウィジェットをクリックしても選べます。
選んだプロファイルは、IDE がこのプロジェクト用に、このコンピューターにだけ保存します。ステータスバーウィジェットには選んだプロファイルが表示されます。
プラグインでできること
- 補完: 実際のテーブルスキーマとインデックスマッピングに基づきます。
- 診断とクイックフィックス。
- ホバー。
- SQL と PartiQL の各ステートメントの上のレンズ行: Run、Open in DynoTable、ステートメントのクエリプラン。
- フォーマット。
- SQL のテーブルエイリアスのリネーム。
- Validate against the index: OpenSearch の JSON クエリで、このインテンションアクションはクエリが有効かどうかをインデックスに確認します。何も実行しません。
- エクスプローラー: DynoTable ツールウィンドウが、プロファイルの DynamoDB テーブルと、 OpenSearch ターゲットごとのインデックスを一覧します。
- ステータスバーウィジェット: プロファイル、または DynoTable が接続していない理由と対処を表示します。
すべてのアクションは Tools → DynoTable と Find Action にあります。
クエリを実行する
ステートメントの上の Run をクリックするか、⌘↩(Windows と Linux では Ctrl+Enter)を押すか、Run DynoTable Query を実行します。Run は選択範囲を使います。選択がなければキャレット位置のステートメントを、それもなければファイル全体を実行します。OpenSearch クエリは、選択範囲かファイル全体を実行します。
行は DynoTable Results ツールウィンドウに表示されます。1 回の実行で返るのは最大 500 行で、合計は DynoTable が件数を把握している場合にだけ表示されます。
ツールバーの Copy All Rows メニューで、行を CSV か JSON としてコピーできます。 Cancel Run(停止アイコン)で実行を止められ、結果タブを閉じても止まります。一度に実行できるステートメントは 1 つです。
結果を操作する
- 選択: セルをクリックするか、セルの上をドラッグするか、行番号か列名をクリックします。 ⌘C(Ctrl+C)は、1 つのセルならその値を、複数のセルならヘッダーなしのタブ区切りテキストをコピーします。
- 集計: 1 つの列で数値のセルを 2 つ以上選択すると、ステータスバーにその件数、合計、平均、最小値、最大値が表示されます。
- 並べ替えと移動: 列ヘッダーの並べ替えアイコンをクリックすると並べ替えます。列ヘッダーをドラッグすると列を移動します。
- フィルター: 列ヘッダーのフィルターアイコンをクリックすると、その列の一部の値だけを残せます。
(empty) は、存在しない値と
nullを表します。 - 検索: ⌘F(Ctrl+F)でグリッドの上に検索バーが開きます。一致するセルが強調表示され、矢印で次の一致に移動します。Filter rows は一致しない行を隠します。
- サイドパネル: Open in Value Editor(⇧↩、またはダブルクリック)は、セルの値全体を表示します。Show Record View(⌘⇧↩、Ctrl+Shift+Enter)は、行を列と値の一覧として表示します。
- コンテキストメニュー: セルを右クリックすると Copy Value と Copy As(CSV、JSON、 Markdown)があります。列ヘッダーを右クリックすると Copy Column、Pin Column、 Hide Column と並べ替えがあります。
- エクスポート: ツールバーの Export… は、すべての行を CSV、JSON、Markdown のいずれかで保存します。
DynoTable エクスプローラー
DynoTable ツールウィンドウには、プロファイルの DynamoDB テーブルと、OpenSearch ターゲットごとのインデックスが表示されます。
テーブルかインデックスの新しいクエリを開くには、それをダブルクリックするか、選択して Enter を押します。コンテキストメニューにも New DynoTable Query があります。 Refresh DynoTable Explorer で一覧を読み直します。
ショートカット
DynoTable のファイルでは、⌘↩ と ⌘⇧↩ は、これらのキーに割り当てられた IDE 自身のアクション(たとえば Split Line、Complete Current Statement、DataGrip の Execute)より先に DynoTable のアクションを実行します。ほかのファイルでは、これらのキーは通常のアクションのままです。
ショートカットを変更するには、Settings → Keymap に移動します。
書き込みはアプリを通す
DynoTable SQL は、SQL Workbench と同じく読み取り専用です。
PartiQL の書き込みはエディタからは実行されません。Stage in DynoTable はアプリでステートメントのテーブルを開きます。そこではステージングが変更をレビュー用に保持します。ステートメントはエディタに残ります。
Open in DynoTable は、ステートメントのテーブルかインデックスでアプリを開きます。レンズをクリックするか、SQL か PartiQL のステートメントにキャレットを置いて ⌘⇧↩ (Ctrl+Shift+Enter)を押します。
プランごとに動くもの
プラグインは無料です。何が動くかは、アプリと同じく DynoTable のライセンスで決まります:
- 無料(サインイン済み): 補完、診断、PartiQL の
SELECTステートメント、OpenSearch クエリ。 - トライアルまたは有料: SQL ステートメントの実行(SQL Workbench と同じ)。OpenSearch インデックスに対する SQL と、DynamoDB テーブルと OpenSearch インデックスの JOIN も含みます。
- サインアウト: 何も動きません。DynoTable にサインインしてください。
ライセンス状態についてはアクティベーションを参照してください。
DynoTable はバックグラウンドで動作する
DynoTable が動いていないとき、プラグインはウィンドウなしでアプリを起動します。アプリは IDE を閉じても動き続け、次の IDE ウィンドウはそれを再び使います。
ウィンドウを戻すには、いつもどおり DynoTable を開くか(Dock、スタートメニュー、アプリランチャー)、 IDE に表示される DynoTable のメッセージで Open DynoTable をクリックします。
次の操作にはアプリのウィンドウが必要です:
- DynoTable へのサインイン。
- 期限切れの AWS サインイン。
- 開いたウィンドウがないプロファイルでの Open in DynoTable。
macOS では、DynoTable の許可プロンプトに IDE の名前が表示されることがあります。アプリを起動したのが IDE だからです。
設定
Settings → Tools → DynoTable に移動します。
| 設定 | 範囲 | デフォルト | 内容 |
|---|---|---|---|
| SQL files | このプロジェクト(.idea/dynotable.xml) | 空 | .sql ファイルの glob パターン。プロジェクトフォルダーからの相対パスです。DynoTable は一致する .sql ファイルを扱います。 |
| App path | このコンピューター | 空 | DynoTable アプリのパス。アプリが標準のインストール場所にない場合に設定します。 |
| User data directory | このコンピューター | 空 | アプリのユーザーデータディレクトリ。設定すると、プラグインはアプリを起動しません。そのディレクトリで DynoTable を自分で起動してください。 |
SQL files 設定はプロジェクトの .idea フォルダーにあるので、チームと共有できます。
App path と User data directory は、IDE がほかのコンピューターに同期しません。
トラブルシューティング
DynoTable が接続していないときは、DynoTable のステータスバーウィジェットをクリックします。対処が表示されます。Reconnect DynoTable で再接続します。
| 問題 | 対処 |
|---|---|
| エディタ連携がオフになっている。 | DynoTable の 設定 → エディタ連携 でオンにし、Reconnect DynoTable を実行します。 |
| DynoTable がサインアウトしている。 | DynoTable を開いてサインインし、Reconnect DynoTable を実行します。 |
| DynoTable が古すぎる。 | DynoTable をアップデートして再起動し、Reconnect DynoTable を実行します。 |
| プラグインがアプリを見つけられない、起動できない。 | Settings → Tools → DynoTable で App path を設定します。 |
| プラグインがアプリを起動しない。 | User data directory が設定されています。そのディレクトリで DynoTable を自分で起動するか、設定を空にします。 |
| プロジェクトで何も動かない。 | プロジェクトを信頼します。DynoTable は信頼されていないプロジェクトでは動きません。 |
.sql ファイルで補完が出ない。 | 名前を *.dynotable.sql に変えるか、Attach SQL File to DynoTable を実行します。 |
| 実行するとプロファイルを求められる。 | Select DynoTable Profile を実行します。プロファイルを選ぶを参照してください。 |
DynoTable をアップデートしても再起動していない場合、古いアプリが一度だけウィンドウを開くことがあります。DynoTable を再起動してください。
プライバシー
プラグインが接続するのは、このコンピューター上の DynoTable アプリだけで、接続先は 127.0.0.1
です。プラグインは接続トークンをアプリから読み取り、保存しません。
IDE は、言語サーバーのすべての通信を Services ツールウィンドウ(LSP コンソール)に表示します。この通信には、接続のたびにトークンが含まれます。言語サービスのデバッグログをオンにすると、IDE のログにもトークンが含まれます。DynoTable はアプリを起動するたびに新しいランダムなトークンを作り、トークンは 127.0.0.1 でだけ有効です。
プラットフォーム
プラグインは macOS でテストしています。Windows と Linux はまだ検証していません。
Linux では、プラグインはアプリを起動する前にアプリのバージョンを読めないため、古すぎるアプリは一度だけウィンドウを開きます。AppImage でインストールした場合は App path 設定が必要です。
次のものには対応していません:
- リモート開発(JetBrains Gateway、JetBrains Client)と WSL 内のプロジェクト。DynoTable が扱うのは、このコンピューター上のファイルだけです。
- Light Edit モード。
- Android Studio。言語サーバーに対応していません。
プラグインのソースは MIT ライセンスで GitHub にあります。