{"id":20162904,"url":"https://github.com/actiontech/sqle-jetbrains-plugin","last_synced_at":"2025-04-10T00:36:19.973Z","repository":{"id":47680865,"uuid":"516209990","full_name":"actiontech/sqle-jetbrains-plugin","owner":"actiontech","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-02T09:26:18.000Z","size":839,"stargazers_count":3,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-02T10:32:37.607Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/actiontech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-07-21T03:22:52.000Z","updated_at":"2025-04-02T09:26:22.000Z","dependencies_parsed_at":"2023-11-27T07:38:36.011Z","dependency_job_id":"e36c0d16-4e84-4716-9290-2bafc924d9d6","html_url":"https://github.com/actiontech/sqle-jetbrains-plugin","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actiontech%2Fsqle-jetbrains-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actiontech%2Fsqle-jetbrains-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actiontech%2Fsqle-jetbrains-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actiontech%2Fsqle-jetbrains-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/actiontech","download_url":"https://codeload.github.com/actiontech/sqle-jetbrains-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137991,"owners_count":21053772,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T00:27:20.399Z","updated_at":"2025-04-10T00:36:19.951Z","avatar_url":"https://github.com/actiontech.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SQLE-Jetbrains-Plugin\n\n## 简介\n\n该项目是[SQLE](https://github.com/actiontech/sqle)\n的 [IDEA 审核插件](https://github.com/actiontech/sqle-jetbrains-plugin) ,\n该插件满足开发人员在开发阶段进行实时自助式的静态SQL审核，实现开发阶段审核上线等各个SQL开发阶段的SQL开发规范。\n\n## 编译\n\nJDK版本11,Gradle版本6.7.1\n\n## 使用方式\n\n### 下载地址\n\n[插件下载地址](https://github.com/actiontech/sqle-jetbrains-plugin/releases)\n\n### 安装插件\n\n1. 点击 [File] - [settings] - [Plugins] 安装\n![安装](https://github.com/actiontech/sqle-jetbrains-plugin/assets/63177450/3ed5d4b1-b47d-4234-95b1-ff812bfa2d46)\n\n\n### 配置插件\n1. 点击 [File] - [Settings] 进入设置界面,点击左侧菜单最下方[SQLE], 填写SQLE环境信息, 点击 [OK] 保存\n![配置](https://github.com/actiontech/sqle-jetbrains-plugin/assets/63177450/d7d86b4c-40d8-46f0-8ac3-3b67d103aa89)\n\n\n2. 配置参数说明\n\n| 配置项             | 配置项说明                                            |\n|-----------------|--------------------------------------------------|\n| SQLE Addr       | SQLE 服务地址, 格式为 IP:Port                           |\n| http/https按钮    | 指定通过http的方式连接SQLE还是通过https的方式连接                  |\n| UserName        | 登录SQLE使用的用户名                                     |\n| Password        | 登录SQLE使用的密码                                      |\n| Test Connection | 测试连接是否成功, 将会尝试登录                                 |\n| Project         | 项目名称                                             |\n| DB Type         | 当其他配置正确时此下拉框会自动获取支持审核的实例类型, 选择后会使用此实例类型的审核规则进行审核 |\n| Data Source     | 数据源名称                                            |\n| Schema          | 数据库名称                                            |\n\n### 使用插件\n1. 选中需要审核的SQL, 可以同时选中多条SQL.点击右键, 选中 [SQLE] - [Audit] , 也可以使用快捷键 [Ctrl] + [Shift] + [H], 插件会以弹窗的形式将审核结果进行展示\n\n![审核sqls](https://github.com/actiontech/sqle-jetbrains-plugin/assets/63177450/81e2f550-8ed3-452c-94ea-0b91fea425e4)\n\n2. 审核mybatis xml文件,选中mybatis xml文件,鼠标右击点击 MyBatis Audit\n\n![审核xml](https://github.com/actiontech/sqle-jetbrains-plugin/assets/63177450/ba9d658e-224b-4693-a87a-3d1c739ed173)\n\n3. 审核sql文件,选中sql文件,鼠标右击点击 SQL file Audit\n\n![审核sql文件](https://github.com/actiontech/sqle-jetbrains-plugin/assets/63177450/0b07a060-7628-4540-b314-e12bcb8ab0d3)\n\n4. 审核结果解读\n\n![image](https://github.com/actiontech/sqle-jetbrains-plugin/assets/63177450/b7b6a6e1-0857-42bd-9274-b56fb8448ca3)\n\n### 升级插件\n\n1. 在 [File] - [settings] - [Plugins] 中卸载旧版插件,重启IDE\n   ![20231102172653_rec_-convert](https://github.com/actiontech/sqle-jetbrains-plugin/assets/63177450/7039da9d-3bc6-4a95-9123-6bb0c38cc802)\n   \n2. 安装新版本插件 \n\n## 常见问题解答\n\n#### 1. 为什么插件配置项中的 [DB Type] 点击时偶尔会卡一下\n\n答: 这是因为点击下拉框时下拉框会连接SQLE获取支持的实例类型, 这个过程可能会出现网络延迟\n\n#### 2. SQLE在审核时使用的规则模板是什么\n\n答: SQLE会根据设置中指定的数据库类型, 选择对应类型的默认模板进行审核, 且只会使用默认模板中的静态审核规则\n\n#### 3. 我没有SQLE环境可以使用这个插件吗\n\n答: SQLE有演示环境,如果只是想尝试一下这个插件可以连接 [演示环境](https://actiontech.github.io/sqle-docs-cn/0.overview/1_online_demo.html)\n\n#### 4. 插件支持哪些IDE\n\n答: Jetbrains家的所有软件都是支持的\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factiontech%2Fsqle-jetbrains-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factiontech%2Fsqle-jetbrains-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factiontech%2Fsqle-jetbrains-plugin/lists"}