IDEA rabbit-sql plugin

Language: English | 简体中文

IDEA 2020.3.* - 2025.3.* is required.

• Support the identification of xql(.xql) file type.
• Support dynamic sql expression script live templates(e.g: xql:if).
• Support quick look sql definition by name(e.g: &my.users).
• Support generate mapper interface by registered xql file.
• Support java and xql file references to navigate each other.
• Support copy sql by focus in sql name.(macOS:Option + Enter , Windows: Alt + Enter) > Copy sql definition .
• Support Execute Dynamic SQL by focus in sql name.(macOS:Option + Enter , Windows: Alt + Enter) > Execute Dynamic sql .
• Support sql name suggestions auto complete in java string literal where start with "&".
• Create xql-file-manager.yml in /src/main/resources and register xql file to enable some features above.
• ToolBar menu: File > New > XQL File | XQL File Manager.

Installation

• Installing from IDEA plugin marketplace:
  • Preferences(Settings) > Plugins > Marketplace > Search and find "rabbit sql" > Install Plugin.
• Installing manually:
  • Download from plugin repository ;
  • Preferences(Settings) > Plugins > ⚙️ > Install plugin from disk... > choose installation package. (no need to unzip)

Getting Started

1. Add dependency rabbit-sql 10.0.2 to your project;
2. Create xql-file-manager.yml in source root: .../src/main/resources/;
3. Register your xql files on property: files;
4. Configure XQLFileManager;
5. Configure BakiDao#setXqlFileManager;

Springboot support

1. Add dependency rabbit-sql-spring-boot-starter 5.0.2 to your project;
2. Create xql-file-manager.yml in source root: .../src/main/resources/;
3. Register your xql files on property: files;

Press Ctrl + s or Tools > Reload XQL File Manager to update sql resource cache when you modify the xql file or xql-file-manager.yml ;

⚠️ Plugin only parse xql file.

Get more information from Rabbit-sql homepage and Springboot support document.