MyBatis Utility
VSCode extension for MyBatis developers. Browse Mapper files, fill query parameters, and execute SQL against configured databases — all without leaving the editor.
Features
- Mapper panel — Scans Java (
@Mapper) and XML mapper files, lists every query by name and type. Includes a real-time filter input and flat / hierarchical view toggle
- Query panel — Click a query to open it, edit SQL inline, fill typed parameters (
#{param}), and execute
- Multi-database support — SQLite, PostgreSQL, MySQL (extensible driver registry)
- Pagination — Large result sets paginated (configurable page size)
- CSV export — Export query results to CSV with one click
- Keyboard shortcuts —
Ctrl+Enter / Ctrl+Shift+Enter to execute without touching the mouse
Requirements
- VSCode 1.85 or later
- For PostgreSQL / MySQL: a running database server (no extra drivers needed — pure JS)
- For SQLite: a
.db / .sqlite file (WASM-based, no native compilation)
Getting Started
Open Settings (Ctrl+,) and search for MyBatis Utility.
Set Scan Folders to the directories that contain your Mapper files:
"mybatisUtility.scanFolders": [
"src/main/java",
"src/main/resources/mapper"
]
Default: ["**/mapper", "**/repository"] — works for most Spring Boot projects out of the box.
The Mappers panel in the sidebar will populate automatically. Use the filter input at the top to narrow results in real time, and use the list/tree icon in the title bar to switch between flat and hierarchical views.
2. Add a database connection
In the Databases panel, click + to add a connection via a quick wizard, or click the gear icon to open the full configuration panel.
Supported types:
| Type |
Connection info |
| SQLite |
Path to .db file |
| PostgreSQL |
host / port / database / schema / user / password |
| MySQL |
host / port / database / user / password |
Passwords are stored in VSCode's Secret Storage (never in plain text).
3. Run a query
- Click any query in the Mappers panel (use the filter input to find it quickly)
- The Query panel opens — the SQL from the mapper file is shown and is editable
- Select a database from the dropdown
- Fill in parameter values (choose type: string / number / boolean / date / null)
- Press Ctrl+Enter to execute, or click execute(all)
To execute only part of the SQL, select it and press Ctrl+Shift+Enter (or click execute(range)).
If you edited the SQL and want to revert it, click reset SQL.
Keyboard Shortcuts
| Shortcut |
Action |
Ctrl+Enter |
execute(all) — run the full displayed SQL |
Ctrl+Shift+Enter |
execute(range) — run only the selected text |
Settings
| Setting |
Default |
Description |
mybatisUtility.scanFolders |
["**/mapper", "**/repository"] |
Glob patterns for mapper file search. Empty = no scan. |
mybatisUtility.fetchLimit |
5000 |
Max rows fetched per query. Reduce to save memory. |
mybatisUtility.pageSize |
200 |
Rows displayed per page in the result panel. |
Open settings with the gear icon (⚙) in the Mappers panel title bar.
Java — annotation-based
@Mapper
public interface UserMapper {
@Select("SELECT * FROM users WHERE id = #{id}")
User findById(String id);
}
XML — MyBatis mapper XML
<mapper namespace="com.example.UserMapper">
<select id="findById" resultType="User">
SELECT * FROM users WHERE id = #{id}
</select>
</mapper>
Both #{param} and ${param} placeholders are detected and shown in the parameter table.
Notes
- No transaction — queries run outside a transaction. There is no rollback. Be careful with INSERT / UPDATE / DELETE.
- fetchLimit warning — if results are truncated, a warning is shown. Add
LIMIT to your SQL or increase fetchLimit in settings.
- The SQL panel is editable — changes affect execution but not the source file. Use reset SQL to restore the original.
License
MIT — see LICENSE
