DynoTable for JetBrains IDEs

The DynoTable plugin lets you write SQL, PartiQL and OpenSearch queries in a JetBrains IDE and run them against the tables and indices of a DynoTable profile. It works in IntelliJ IDEA, DataGrip, WebStorm, PyCharm, GoLand, Rider and other JetBrains IDEs with language server support.

The DynoTable desktop app on the same computer serves the language features from your real schemas and runs the queries. The query files and the language are the same as in DynoTable for VS Code.

What you need

  • A JetBrains IDE with language server support, version 2026.3 or later.
  • A trusted project.
  • DynoTable 1.19.0 or later, installed on the same computer.
  • Editor integration switched on in the app. It is off by default.

Remote development, projects in WSL, Light Edit mode and Android Studio are not supported. See Platforms.

Turn on Editor integration

  1. Open DynoTable.
  2. Go to Settings → Editor integration.
  3. Switch on Editor integration.

You do this one time. After that, the plugin starts DynoTable when it needs the app. See DynoTable runs in the background.

Install the plugin

  1. In the IDE, go to Settings → Plugins.
  2. Open the Marketplace tab.
  3. Search for DynoTable and click Install.

You can also install it from its JetBrains Marketplace page.

Query files

FileFile typeLanguage
*.dynotable.sqlDynoTable SQLDynoTable SQL, over tables and indices
*.partiqlDynoTable PartiQLDynamoDB PartiQL
*.opensearchDynoTable OpenSearchOne OpenSearch query: JSON query DSL or Lucene

DynoTable serves these files also when they are scratch files or outside the project.

New DynoTable Query asks for SQL, PartiQL or OpenSearch and opens a new query in that language as a scratch file.

SQL files

DynoTable does not attach to every .sql file. It attaches to *.dynotable.sql files and to the files that match the SQL files setting of the project.

To attach another .sql file, open it and run Tools → DynoTable → Attach SQL File to DynoTable. The action adds the file to the SQL files setting of the project. Only a .sql file in the project can attach. Each open project has its own SQL files setting.

A SQL file can query DynamoDB tables and OpenSearch indices, and one statement can join a table to an index. See One SQL file, two engines.

OpenSearch files

An OpenSearch query names its index on its first line:

// dynotable: index=orders
{"query": {"match": {"status": "shipped"}}}

Run Pick OpenSearch Index to choose the index from a list. It writes that line for you.

When two OpenSearch targets have an index with the same name, the line also needs target=<target name>. It needs it too when DynoTable could not list the indices of every target.

Pick OpenSearch Index and the explorer's New DynoTable Query add it for you. A target name that contains a space cannot go on that line.

Pick a profile

A connection uses one DynoTable profile.

  • When DynoTable has one profile, the plugin uses it.
  • When it has more, run Select DynoTable Profile and pick one. While no profile is selected, a click on the DynoTable status bar widget also offers it.

The IDE keeps your choice for this project, on this computer only. The status bar widget shows the profile you selected.

What the plugin does

  • Completion from your real table schemas and index mappings.
  • Diagnostics with quick fixes.
  • Hover.
  • A lens row above each SQL and PartiQL statement: Run, Open in DynoTable and the query plan of the statement.
  • Formatting.
  • Rename of table aliases in SQL.
  • Validate against the index: in an OpenSearch JSON query, this intention action asks the index whether the query is valid. Nothing runs.
  • Explorer: the DynoTable tool window lists the DynamoDB tables of the profile and, for each OpenSearch target, its indices.
  • Status bar widget: shows the profile, or why DynoTable is not connected and what to do.

All actions are in Tools → DynoTable and in Find Action.

Run a query

Click Run above a statement, press ⌘↩ (Ctrl+Enter on Windows and Linux), or run Run DynoTable Query. Run uses the selection. With no selection, it runs the statement at the caret, or else the whole file. An OpenSearch query runs the selection or the whole file.

The rows show in the DynoTable Results tool window. A run returns up to 500 rows, and the tool window shows the total only when DynoTable knows it.

The Copy All Rows menu in its toolbar copies the rows as CSV or JSON. Cancel Run (the stop icon) stops the run, and so does closing the results tab. You can run one statement at a time.

Work with the results

  • Select: click a cell, drag over cells, click a row number or click a column name. ⌘C (Ctrl+C) copies one cell as its value, and more cells as tab-separated text with no header.
  • Totals: when you select 2 or more number cells in a column, the status bar shows their count, sum, average, minimum and maximum.
  • Sort and move: click the sort icon in a column header to sort. Drag a column header to move the column.
  • Filter: click the filter icon in a column header to keep only some of its values. (empty) stands for missing and null values.
  • Find: ⌘F (Ctrl+F) opens a find bar above the grid. It highlights the matching cells, its arrows move to the next match, and Filter rows hides the rows without a match.
  • Side panel: Open in Value Editor (⇧↩, or a double-click) shows the full value of a cell. Show Record View (⌘⇧↩, Ctrl+Shift+Enter) shows the row as a list of columns and values.
  • Context menus: right-click a cell for Copy Value and Copy As CSV, JSON or Markdown. Right-click a column header for Copy Column, Pin Column, Hide Column and sorting.
  • Export: Export… in the toolbar saves all rows as CSV, JSON or Markdown.

The DynoTable explorer

The DynoTable tool window shows the DynamoDB tables of the profile and, for each OpenSearch target, its indices.

To open a new query for a table or an index, double-click it or select it and press Enter. Its context menu also has New DynoTable Query. Refresh DynoTable Explorer reads the lists again.

Shortcuts

In DynoTable files, ⌘↩ and ⌘⇧↩ run the DynoTable actions before the IDE's own actions on these keys, for example Split Line, Complete Current Statement, and Execute in DataGrip. In other files, the keys keep their usual actions.

To change the shortcuts, go to Settings → Keymap.

Writes go through the app

DynoTable SQL is read-only, as in the SQL Workbench.

A PartiQL write does not run from the editor. Stage in DynoTable opens the statement's table in the app, where staging holds the change for review. The statement stays in the editor.

Open in DynoTable opens the app at the statement's table or index. Click the lens, or press ⌘⇧↩ (Ctrl+Shift+Enter) with the caret in a SQL or PartiQL statement.

What runs on your plan

The plugin is free. What runs depends on your DynoTable license, as in the app:

  • Free (signed in): completion, diagnostics, PartiQL SELECT statements and OpenSearch queries.
  • Trial or paid: running SQL statements, as in the SQL Workbench. This includes SQL over an OpenSearch index and a JOIN of a DynamoDB table to an OpenSearch index.
  • Signed out: nothing. Sign in to DynoTable.

See Activation for the license states.

DynoTable runs in the background

When DynoTable is not running, the plugin starts it with no window. The app keeps running after you close the IDE, and the next IDE window uses it again.

To get a window back, open DynoTable as usual (Dock, Start menu or app launcher), or click Open DynoTable in a DynoTable message in the IDE.

These actions need an app window:

  • Signing in to DynoTable.
  • An expired AWS sign-in.
  • Open in DynoTable on a profile with no open window.

On macOS, a permission prompt from DynoTable can name your IDE, because the IDE started the app.

Settings

Go to Settings → Tools → DynoTable.

SettingScopeDefaultWhat it does
SQL filesThis project (.idea/dynotable.xml)emptyGlob patterns of .sql files, relative to the project folder. DynoTable serves the .sql files that match.
App pathThis computeremptyThe path of the DynoTable app. Set it when the app is not in its standard install location.
User data directoryThis computeremptyThe app's user data directory. When set, the plugin does not start the app. Start DynoTable with it yourself.

The SQL files setting is in the project's .idea folder, so you can share it with your team. The IDE does not sync App path and User data directory to other computers.

Troubleshooting

When DynoTable is not connected, click the DynoTable status bar widget. It tells you what to do. Reconnect DynoTable connects again.

ProblemWhat to do
The Editor integration is off.Turn it on in DynoTable under Settings → Editor integration, then run Reconnect DynoTable.
DynoTable is signed out.Open DynoTable, sign in, then run Reconnect DynoTable.
DynoTable is too old.Update DynoTable, restart it, then run Reconnect DynoTable.
The plugin cannot find or start the app.Set App path in Settings → Tools → DynoTable.
The plugin does not start the app.User data directory is set. Start DynoTable with that directory yourself, or clear the setting.
Nothing works in the project.Trust the project. DynoTable does not run in an untrusted project.
A .sql file gets no completion.Rename it to *.dynotable.sql, or run Attach SQL File to DynoTable.
Runs ask for a profile.Run Select DynoTable Profile. See Pick a profile.

If you updated DynoTable but did not restart it, the old app can open a window one time. Restart DynoTable.

Privacy

The plugin connects only to the DynoTable app on your computer, on 127.0.0.1. It reads the connection token from the app and does not store it.

The IDE shows all language server traffic in the Services tool window (the LSP console). This traffic includes the token, on each connection. When you switch on debug logging for language services, the IDE's logs also contain it. DynoTable makes a new random token each time the app starts, and the token is valid only on 127.0.0.1.

Platforms

The plugin is tested on macOS. Windows and Linux are not verified yet.

On Linux, the plugin cannot read the app version before it starts the app, so an app that is too old opens a window one time. An AppImage install needs the App path setting.

These are not supported:

  • Remote development (JetBrains Gateway, JetBrains Client) and projects in WSL. DynoTable serves only files on this computer.
  • Light Edit mode.
  • Android Studio. It has no language server support.

The plugin's source is on GitHub under the MIT license.

Updated