Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 3.15 KB

README.chs.md

File metadata and controls

59 lines (44 loc) · 3.15 KB
Raw

IDEA rabbit-sql plugin

HomePage License Version Downloads

语言: English | 简体中文

IDEA 版本兼容 2020.3.* - 2024.3.* 。

  • 支持识别 xql（.xql） 文件类型；
  • 支持动态sql表达式脚本 live templates（例如：xql:if）；
  • 支持通过sql名字快速查看sql语句（例如：&my.users）；
  • 支持通过注册的xql文件生成映射器接口；
  • 支持java文件和xql文件sql引用导航；
  • 鼠标点击sql名支持拷贝sql语句内容.（macOS:Option + Enter , Windows: Alt + Enter) > Copy sql definition ；
  • 鼠标点击sql名支持测试动态sql.(macOS:Option + Enter , Windows: Alt + Enter) > Execute Dynamic sql )；
  • java文件中字符串字面量以 & 开头支持sql名自动完成提示建议；
  • 在 /src/main/resources 目录下创建文件 xql-file-manager.yml 并配置xql文件可以开启支持以上全部功能；
  • 工具栏菜单: File > New > XQL File | XQL File Manager。

安装

  • 通过IDEA插件商店进行安装：
    • Preferences(Settings) > Plugins > Marketplace > Search and find "rabbit sql" > Install Plugin；
  • 通过插件资源库手动下载安装：
    • Preferences(Settings) > Plugins > ⚙️ > Install plugin from disk... > 选择插件安装包（不需要解压）。

开始使用

  1. 项目中引入 rabbit-sql 8.1.0+；
  2. 在源文件根目录: .../src/main/resources/ 下创建 xql-file-manager.yml；
  3. 为属性: files 配置你的xql文件；
  4. 配置 XQLFileManager;
  5. 配置 BakiDao#setXqlFileManager;

Springboot支持

  1. 项目中引入 rabbit-sql-spring-boot-starter 3.1.0+；
  2. 在源文件根目录: .../src/main/resources/ 下创建 xql-file-manager.yml；
  3. 为属性: files 配置你的xql文件；

每当修改了 xql 文件或 xql-file-manager.yml 时，按 Ctrl + s 或者 Tools > Reload XQL File Manager 来触发更新缓存；

⚠️ 插件仅支持解析 xql 文件。

从 rabbit-sql 主页 和 Springboot 支持文档 获取更多的帮助信息。