Compatibility & Requirements
IDE versions
- IntelliJ IDEA 2024.3 or later (build 243+), no upper bound — always adapted to the latest release
- Other IntelliJ Platform IDEs (PyCharm, WebStorm, GoLand, etc. 2024.3+) install fine, but MyBatis / JPA capabilities need a Java context — IDEA Ultimate or Community is recommended
- Ultimate-only capability: executing SQL straight from the preview popup with
Ctrl+Enter(requires the bundled Database plugin)
Runtime
- The plugin runs on the IDE's bundled JBR (JetBrains Runtime) — no extra JDK or environment setup needed
- No project dependencies required; preview, restore and reverse conversion are local static analysis. The optional enhanced-capture channel, when enabled, attaches capture points to your application's JVM on the local machine (on by default, no confirmation dialog; switch it off in settings) — data stays in the local IDE
Framework coverage
| Framework | Supported |
|---|---|
| MyBatis-Plus | Lambda / string Wrappers, service chains, logical delete, optimistic locking |
| MyBatis-Plus-Join | MPJLambdaWrapper / MPJQueryWrapper joins |
| MyBatis | XML dynamic SQL, annotation SQL (including <script> and Provider) |
| Spring JdbcTemplate | String SQL, NamedParameterJdbcTemplate named parameters |
| Spring Data JPA | Derived queries, Repository CRUD write paths (save / findById / delete family), @Query (JPQL / native SQL), @NamedQuery, CriteriaBuilder, Specification, QueryByExample, Pageable / Sort |
| Hibernate | HQL, .hbm.xml mappings and <query> / <sql-query> named queries |
Other ORM (MVP)
First-stage support: common chain and annotation styles are covered; rarer shapes follow what the plugin actually recognizes.
| Framework | Supported |
|---|---|
| xbatis (formerly mybatis-mp) | chain APIs |
| Easy-Query | proxy style |
| MyBatis Dynamic SQL | SelectDSL |
| Querydsl | JPAQueryFactory |
| Spring Data JDBC / R2DBC | @Query / @Modifying |
Installation channels
- JetBrains Marketplace (recommended): in the IDE,
Settings>Plugins>Marketplace, searchSQL Visualizer; with the IDE running you can also one-click install from the Marketplace page - Offline: download the plugin package from Gitee Releases, then
Settings>Plugins> ⚙ >Install Plugin from Disk... - Early-access builds ship through the Gitee internal update channel — see the About page
- Intranet / no internet: core features work entirely offline; see Offline & Intranet for network behavior, JDBC driver preparation and an internal update channel
If something does not work
First confirm the IDE version is ≥ 2024.3, then check the FAQ. If the problem persists, please open a Feedback Pool with your IDE version and the error output.