# mybatis-log-plugin

**Repository Path**: anuo/mybatis-log-plugin

## Basic Information

- **Project Name**: mybatis-log-plugin
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-06-11
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

MyBatis Log Plugin
==============================
![MyBatisLogPlugin.gif](https://raw.githubusercontent.com/kookob/mybatis-log-plugin/master/snapshot/MyBatisLogPlugin.gif)

**English Introduction**
---
This is a plugin for IntelliJ IDEA that restore the mybatis generate sql to original whole sql.<br/>
It will generate sql statements with replace ? to the really param value.<br/>
Through the "Tools -> MyBatis Log Plugin" menu you can tail the sql log.<br/>
You can selected the "Filter" button on the left to filter the contents don't wanna display.<br/>
You can selected the "Format Sql" button on the left to format the generate sql statements.<br/>
**Prerequisite: sql log must contain "Preparing:" and "Parameters:"**<br/>

The left buttons function:<br/>

* Filter: Filter setting
* Rerun: Rerun this plugin
* Stop: Stop output the sql log
* Format Sql: Format the **subsequent** sql statements
* Close: Close this plugin window

**Support Format**
---
Support the mybatis's output format below:<br/>


`2016-11-11 16:46:29.316 DEBUG selectSql1 -  ==>  Preparing: select * from t_table where name = ?`
`2016-11-11 16:46:29.343 DEBUG selectSql1 -  ==> Parameters: hello(String)`

Use "Preparing:" and "Parameters:" characters to split the log sql.<br/>
And it will output the whole sql:<br/>
`select * from t_table where name = 'hello';`<br/>

**Download Plugin**
---
[mybatis-log-plugin.jar](https://plugins.jetbrains.com/plugin/10065-mybatis-log-plugin "Download Plugin")


---


**中文介绍**
---
这是一个Intellij的插件，主要作用是把mybatis生成的PreparedStatement语句恢复成原始完整的sql语句。<br/>
它将用真实的参数值替换PreparedStatement语句的问号占位符。<br/>
通过 "Tools -> MyBatis Log Plugin" 这个菜单可以实时输出sql日志。<br/>
点击窗口左边的 "Filter" 按钮，可以过滤不想要输出的sql语句。<br/>
点击窗口左边的 "Format Sql" 按钮，可以格式化输出的sql语句。<br/>
**前提条件：输出的sql日志必须包含"Preparing:"和"Parameters:"才能正常解析。**<br/>

左边几个按钮的作用：<br/>

* Filter: 过滤语句配置
* Rerun: 重新启动
* Stop: 停止输出
* Format Sql: 格式化**后续**输出的Sql语句
* Close: 关闭该窗口

**支持格式**
---
支持mybatis的输出格式如下：<br/>

`2016-11-11 16:46:29.316 DEBUG selectSql1 -  ==>  Preparing: select * from t_table where name = ?`
`2016-11-11 16:46:29.343 DEBUG selectSql1 -  ==> Parameters: hello(String)`

以 "Preparing:" 和 "Parameters:" 作为分割符进行解析。<br/>
接着输出的完成sql语句如下：<br/>
`select * from t_table where name = 'hello';`<br/>

**插件下载**
---
[mybatis-log-plugin.jar](https://plugins.jetbrains.com/plugin/10065-mybatis-log-plugin "插件下载")

**项目地址**
---
<https://github.com/kookob/mybatis-log-plugin>

**参考列表**
---
Reference and copy some code from below list:<br/>
<https://github.com/JetBrains/intellij-community> <br/>
<https://github.com/krasa/GrepConsole><br/>
<https://github.com/hibernate/hibernate-orm><br/>