admin/mybatis-flex
1
0
Fork 0
mirror of https://gitee.com/mybatis-flex/mybatis-flex.git synced 2025-12-07 00:58:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: update docs

Browse Source
This commit is contained in:
开源海哥 2023-08-03 18:33:23 +08:00
parent f4de1f1e5a
commit 4d273dc74e
2 changed files with 89 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
docs/zh/base/querywrapper.md
View File

@ -17,10 +17,10 @@ public class AccountController {
@Autowired @Autowired
AccountMapper accountMapper; AccountMapper accountMapper;
@GetMapping("/accounts") @GetMapping("/accounts")
List<Account> selectList() { List<Account> selectList() {
//构造 QueryWrapper，也支持使用 QueryWrapper.create() 构造，效果相同 //构造 QueryWrapper，也支持使用 QueryWrapper.create() 构造，效果相同
QueryWrapper query = new QueryWrapper(); QueryWrapper query = new QueryWrapper();
query.where(ACCOUNT.ID.ge(100)); query.where(ACCOUNT.ID.ge(100));
@ -148,7 +148,7 @@ select(column("abc")) --> SELECT abc
，然后在自己的项目里进行自定义扩展。 ，然后在自己的项目里进行自定义扩展。
| 支持的函数 | 函数说明 | | 支持的函数 | 函数说明 |
| -------- | -------- | | -------- | -------- |
| count | 查询数据总量 | | count | 查询数据总量 |
| distinct | 对指定列进行去重 | | distinct | 对指定列进行去重 |
@ -339,11 +339,11 @@ QueryWrapper wrapper = QueryWrapper.create()
其查询生成的 Sql 如下： 其查询生成的 Sql 如下：
```sql ```sql
SELECT `id`, SELECT `id`,
(CASE WHEN `id` >= 2 THEN 'x2' (CASE WHEN `id` >= 2 THEN 'x2'
WHEN `id` >= 1 THEN 'x1' WHEN `id` >= 1 THEN 'x1'
ELSE 'x100' ELSE 'x100'
END) AS `xName` END) AS `xName`
FROM `tb_account` FROM `tb_account`
``` ```
@ -374,12 +374,12 @@ QueryWrapper queryWrapper = QueryWrapper.create()
其查询生成的 Sql 如下： 其查询生成的 Sql 如下：
```sql ```sql
SELECT *, SELECT *,
(CASE `id` (CASE `id`
WHEN 100 THEN 100 WHEN 100 THEN 100
WHEN 200 THEN 200 WHEN 200 THEN 200
ELSE 300 END) AS `result` ELSE 300 END) AS `result`
FROM `tb_account` FROM `tb_account`
WHERE `user_name` LIKE ? WHERE `user_name` LIKE ?
``` ```
@ -408,7 +408,7 @@ System.out.println(query.toSQL());
生成的 SQL 如下： 生成的 SQL 如下：
```sql ```sql
WITH CTE AS (SELECT * FROM `tb_article` WHERE `id` >= 100) WITH CTE AS (SELECT * FROM `tb_article` WHERE `id` >= 100)
SELECT * FROM `tb_account` WHERE `sex` = 1 SELECT * FROM `tb_account` WHERE `sex` = 1
``` ```
@ -432,8 +432,8 @@ System.out.println(query.toSQL());
生成的 SQL 如下： 生成的 SQL 如下：
```sql ```sql
WITH xxx(id, name) WITH xxx(id, name)
AS (VALUES (a, b) UNION (SELECT * FROM `tb_article` WHERE `id` >= 200)) AS (VALUES (a, b) UNION (SELECT * FROM `tb_article` WHERE `id` >= 200))
SELECT * FROM `tb_account` WHERE `sex` = 1 SELECT * FROM `tb_account` WHERE `sex` = 1
``` ```
@ -458,7 +458,7 @@ System.out.println(query.toSQL());
生成的 SQL 如下： 生成的 SQL 如下：
```sql ```sql
WITH RECURSIVE CTE AS (SELECT * FROM `tb_article` WHERE `id` >= 100) WITH RECURSIVE CTE AS (SELECT * FROM `tb_article` WHERE `id` >= 100)
SELECT * FROM `tb_account` WHERE `sex` = 1 SELECT * FROM `tb_account` WHERE `sex` = 1
``` ```
@ -485,9 +485,9 @@ System.out.println(query.toSQL());
生成的 SQL 如下： 生成的 SQL 如下：
```sql ```sql
WITH RECURSIVE WITH RECURSIVE
CTE AS (SELECT * FROM `tb_article` WHERE `id` >= 100), CTE AS (SELECT * FROM `tb_article` WHERE `id` >= 100),
xxx(id, name) AS (VALUES (a, b) UNION (SELECT * FROM `tb_article` WHERE `id` >= 200)) xxx(id, name) AS (VALUES (a, b) UNION (SELECT * FROM `tb_article` WHERE `id` >= 200))
SELECT * FROM `tb_account` WHERE `sex` = 1 SELECT * FROM `tb_account` WHERE `sex` = 1
``` ```
@ -509,7 +509,7 @@ QueryWrapper queryWrapper=QueryWrapper.create()
```sql ```sql
SELECT * FROM tb_account SELECT * FROM tb_account
WHERE id >= ? WHERE id >= ?
AND user_name LIKE ? AND user_name LIKE ?
``` ```
## where 动态条件 1 ## where 动态条件 1
@ -526,7 +526,7 @@ QueryWrapper queryWrapper = QueryWrapper.create()
```sql ```sql
SELECT * FROM tb_account SELECT * FROM tb_account
WHERE user_name LIKE ? WHERE user_name LIKE ?
``` ```
## where 动态条件 2 ## where 动态条件 2
@ -543,7 +543,7 @@ QueryWrapper queryWrapper = QueryWrapper.create()
```sql ```sql
SELECT * FROM tb_account SELECT * FROM tb_account
WHERE user_name LIKE ? WHERE user_name LIKE ?
``` ```
## where 动态条件 3 ## where 动态条件 3
@ -560,7 +560,7 @@ QueryWrapper queryWrapper = QueryWrapper.create()
```sql ```sql
SELECT * FROM tb_account SELECT * FROM tb_account
WHERE id >= ? WHERE id >= ?
``` ```
## where 动态条件 4 ## where 动态条件 4
@ -569,7 +569,7 @@ WHERE id >= ?
String name = null; String name = null;
QueryWrapper queryWrapper = QueryWrapper.create() QueryWrapper queryWrapper = QueryWrapper.create()
.select().from(ACCOUNT) .select().from(ACCOUNT)
.where(ACCOUNT.ID.ge(100)) .where(ACCOUNT.ID.ge(100))
.and(ACCOUNT.USER_NAME.like(name, If::hasText)); .and(ACCOUNT.USER_NAME.like(name, If::hasText));
``` ```
@ -577,7 +577,7 @@ QueryWrapper queryWrapper = QueryWrapper.create()
```sql ```sql
SELECT * FROM tb_account SELECT * FROM tb_account
WHERE id >= ? WHERE id >= ?
``` ```
## where select ## where select
@ -749,9 +749,9 @@ QueryWrapper queryWrapper = QueryWrapper.create()
其查询生成的 Sql 如下： 其查询生成的 Sql 如下：
```sql ```sql
SELECT * FROM tb_account LEFT JOIN tb_article SELECT * FROM tb_account LEFT JOIN tb_article
ON tb_account.id = tb_article.account_id AND tb_account.age = ? ON tb_account.id = tb_article.account_id AND tb_account.age = ?
WHERE tb_account.age >= ? WHERE tb_account.age >= ?
``` ```
## join select ## join select
@ -772,12 +772,47 @@ QueryWrapper queryWrapper = QueryWrapper.create()
其查询生成的 Sql 如下： 其查询生成的 Sql 如下：
```sql ```sql
SELECT * FROM tb_account SELECT * FROM tb_account
LEFT JOIN (SELECT * FROM tb_article WHERE id >= ? ) AS a LEFT JOIN (SELECT * FROM tb_article WHERE id >= ? ) AS a
ON tb_account.id = a.id ON tb_account.id = a.id
WHERE tb_account.age >= ? WHERE tb_account.age >= ?
``` ```
## join 自己
```java
QueryWrapper queryWrapper = QueryWrapper.create();
queryWrapper.from(ACCOUNT)
.leftJoin(ACCOUNT).as("a1").on(ACCOUNT.ID.eq(ACCOUNT.PARENT_ID))
.leftJoin(ACCOUNT).as("a2").on(ACCOUNT.ID.eq(ACCOUNT.PARENT_ID))
.where(ACCOUNT.ID.ge(1));
```
其查询生成的 Sql 如下：
```sql
SELECT * FROM `tb_account`
LEFT JOIN `tb_account` AS `a1`
ON `a1`.`id` = `tb_account`.`parent_id`
LEFT JOIN `tb_account` AS `a2`
ON `a2`.`id` = `tb_account`.`parent_id`
WHERE `tb_account`.`id` >= ?
```
若 `tb_account` 表带有逻辑删除，那么其生成的 SQL 如下：
```sql
SELECT * FROM `tb_account`
LEFT JOIN `tb_account` AS `a1`
ON `a1`.`id` = `tb_account`.`parent_id` AND `a1`.`is_delete` = ?
LEFT JOIN `tb_account` AS `a2`
ON `a2`.`id` = `tb_account`.`parent_id` AND `a2`.`is_delete` = ?
WHERE `tb_account`.`id` >= ?
AND `tb_account`.`is_delete` = ?
```
> 关于逻辑删除更多文档请参考 [这里](../core/logic-delete.html)。
## union, union all ## union, union all
```java ```java
@ -792,8 +827,8 @@ QueryWrapper query = new QueryWrapper()
其查询生成的 Sql 如下： 其查询生成的 Sql 如下：
```sql ```sql
(SELECT id FROM tb_account ORDER BY id DESC) (SELECT id FROM tb_account ORDER BY id DESC)
UNION (SELECT id FROM tb_article) UNION (SELECT id FROM tb_article)
UNION ALL (SELECT id FROM tb_article) UNION ALL (SELECT id FROM tb_article)
``` ```
@ -894,12 +929,12 @@ System.out.println(query.toSQL());
SQL 输入内容如下： SQL 输入内容如下：
```sql ```sql
SELECT * FROM `tb_article` SELECT * FROM `tb_article`
LEFT JOIN `tb_account` AS `a` ON `a`.`id` = `tb_article`.`account_id` LEFT JOIN `tb_account` AS `a` ON `a`.`id` = `tb_article`.`account_id`
WHERE `a`.`id` >= 100 AND WHERE `a`.`id` >= 100 AND
(`a`.`id` >= 100 (`a`.`id` >= 100
OR `a`.`age` > 200 OR `a`.`age` > 200
AND `tb_article`.`account_id` = 200 AND `tb_article`.`account_id` = 200
OR (`a`.`id` LIKE '%a%' ) OR (`a`.`id` LIKE '%a%' )
) )
``` ```

14
docs/zh/intro/getting-started.md
View File

@ -7,7 +7,19 @@
- 熟悉 Spring Boot 及相关框架 - 熟悉 Spring Boot 及相关框架
- 熟悉 Java 构建工具，比如 Maven - 熟悉 Java 构建工具，比如 Maven
## Hello World > 当前章节涉及到的源码已经全部上传到：https://gitee.com/Suomm/mybatis-flex-test ，在开始之前，
> 您也可以先下载到本地，导入到 idea 开发工具后，在继续看文档。
## Hello World 视频教程
<iframe width="100%" height="400px" src="//player.bilibili.com/player.html?aid=955526987&bvid=BV1yW4y1Z74j&cid=1187300793&page=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true"> </iframe>
MyBatis-Flex 视频系列详情：https://www.bilibili.com/video/BV1yW4y1Z74j
## Hello World 文档
**第 1 步：创建数据库表** **第 1 步：创建数据库表**