Dialect (yue-library-码云(gitee.com))

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

AnsiDialect, DmDialect, MysqlDialect, PostgresqlDialect
```
public interface Dialect
extends Serializable, Cloneable
```
SQL方言
由于不同数据库间SQL语句的差异，导致无法统一拼接SQL，Dialect接口旨在根据不同的数据库，使用不同的方言实现类，来拼接对应的SQL。
设计模式借鉴于hutool-db

Since:

2020年6月13日

Author:

ylyue

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Dialect`	`cloneDialect()` 克隆方言
`DialectNameEnum`	`dialectName()` 方言名
`JdbcProperties`	`getJdbcProperties()` Db可配置属性
`org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate`	`getNamedParameterJdbcTemplate()` 命名参数JdbcTemplate
`String`	`getPageJoinSql()` 获得用于SQL字符串拼接的SQL分页字符串
`Wrapper`	`getWrapper()` 包装器
`Long`	`insertOrUpdate(String tableName, com.alibaba.fastjson.JSONObject paramJson, String[] conditions, DbUpdateEnum dBUpdateEnum)` 插入或更新表中必须存在数据唯一性约束
`<T> PageVO<T>`	`page(String tableName, PageIPO pageIPO, SortEnum sortEnum, Class<T> mappedClass)` 单表分页查询
`<T> PageVO<T>`	`pageSql(String querySql, PageIPO pageIPO, Class<T> mappedClass)` 复杂SQL分页查询
`<T> PageVO<T>`	`pageSql(String countSql, String querySql, PageIPO pageIPO, Class<T> mappedClass)` 复杂SQL分页查询
`<T> PageVO<T>`	`pageWhere(String tableName, String whereSql, PageIPO pageIPO, Class<T> mappedClass)` 单表分页查询
`void`	`setJdbcProperties(JdbcProperties jdbcProperties)` 设置Db可配置属性
`void`	`setNamedParameterJdbcTemplate(org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate namedParameterJdbcTemplate)` 设置命名参数JdbcTemplate
`void`	`setWrapper(Wrapper wrapper)` 设置包装器
`Page`	`toPage(PageIPO pageIPO)` 转换为经过方言处理的分页查询参数，用于SQL分页查询

- Method Detail
  - dialectName
```
DialectNameEnum dialectName()
```
    方言名
    
    Returns:
    
    方言名
  - cloneDialect
```
Dialect cloneDialect()
```
    克隆方言
    
    Returns:
    
    克隆方言
  - getWrapper
```
Wrapper getWrapper()
```
    包装器
    
    Returns:
    
    包装器
  - setWrapper
```
void setWrapper(Wrapper wrapper)
```
    设置包装器
    
    Parameters:
    
    wrapper - 包装器
  - getNamedParameterJdbcTemplate
```
org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate getNamedParameterJdbcTemplate()
```
    命名参数JdbcTemplate
    
    Returns:
    
    命名参数JdbcTemplate
  - setNamedParameterJdbcTemplate
```
void setNamedParameterJdbcTemplate(org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate namedParameterJdbcTemplate)
```
    设置命名参数JdbcTemplate
    
    Parameters:
    
    namedParameterJdbcTemplate - 命名参数JdbcTemplate
  - getJdbcProperties
```
JdbcProperties getJdbcProperties()
```
    Db可配置属性
    
    Returns:
    
    Db可配置属性
  - setJdbcProperties
```
void setJdbcProperties(JdbcProperties jdbcProperties)
```
    设置Db可配置属性
    
    Parameters:
    
    jdbcProperties - Db可配置属性
  - insertOrUpdate
```
Long insertOrUpdate(String tableName,
                    com.alibaba.fastjson.JSONObject paramJson,
                    String[] conditions,
                    DbUpdateEnum dBUpdateEnum)
```
    插入或更新 表中必须存在数据唯一性约束
    更新触发条件：此数据若存在唯一性约束则更新，否则便执行插入数据
    MySQL执行示例：
    INSERT INTO table (param1, param2, ...)
    VALUES
    (:param1, :param2, ...)
    ON DUPLICATE KEY UPDATE
    condition = condition + :condition, ...
    
    Parameters:
    
    tableName - 表名
    
    paramJson - 插入或更新所用到的参数
    
    conditions - 更新条件（对应paramJson内的key值）
    
    dBUpdateEnum - 更新类型 DbUpdateEnum
    
    Returns:
    
    受影响的行数
  - getPageJoinSql
```
String getPageJoinSql()
```
    获得用于SQL字符串拼接的SQL分页字符串
    
    Returns:
    
    用于SQL字符串拼接的SQL分页字符串（带具名参数的SQL字符串，非SQL拼接）
  - toPage
```
Page toPage(PageIPO pageIPO)
```
    转换为经过方言处理的分页查询参数，用于SQL分页查询
    
    Parameters:
    
    pageIPO - 分页查询参数
    
    Returns:
    
    经过方言处理的分页查询参数
  - page
```
<T> PageVO<T> page(String tableName,
                   PageIPO pageIPO,
                   SortEnum sortEnum,
                   Class<T> mappedClass)
```
    单表分页查询
    
    阿里最优SQL示例：
    SELECT a.* FROM 表1 a, (select id from 表1 where 条件 ORDER BY id LIMIT 100000,20 ) b where a.id=b.id
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    tableName - 表名
    
    pageIPO - 分页查询参数 PageIPO，所有的条件参数，都将以等于的形式进行SQL拼接
    
    sortEnum - 排序方式 SortEnum
    
    mappedClass - 映射类
    
    Returns:
    
    count（总数），data（分页列表数据）
  - pageWhere
```
<T> PageVO<T> pageWhere(String tableName,
                        String whereSql,
                        PageIPO pageIPO,
                        Class<T> mappedClass)
```
    单表分页查询
    
    阿里最优SQL示例：
    SELECT a.* FROM 表1 a, (select id from 表1 where 条件 LIMIT 100000,20 ) b where a.id=b.id
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    tableName - 表名
    
    whereSql - 自定义WHERE语句，若此参数为空，那么所有的条件参数，都将以等于的形式进行SQL拼接。
    SQL示例： WHERE 条件
    
    pageIPO - 分页查询参数 PageIPO
    
    mappedClass - 映射类
    
    Returns:
    
    count（总数），data（分页列表数据）
  - pageSql
```
<T> PageVO<T> pageSql(String querySql,
                      PageIPO pageIPO,
                      Class<T> mappedClass)
```
    复杂SQL分页查询
    
    阿里最优查询SQL示例：
    SELECT a.* FROM 表1 a, (select id from 表1 where 条件 LIMIT :page, :limit) b where a.id=b.id
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    querySql - 用于查询数据的sql语句
    
    pageIPO - 分页查询参数 PageIPO
    
    mappedClass - 映射类
    
    Returns:
    
    count（总数），data（分页列表数据）
  - pageSql
```
<T> PageVO<T> pageSql(@Nullable
                      String countSql,
                      String querySql,
                      PageIPO pageIPO,
                      Class<T> mappedClass)
```
    复杂SQL分页查询
    
    统计SQL示例：
    SELECT count(*) count FROM 表1 a, (select id from 表1 where 条件) b where a.id=b.id
    
    阿里最优查询SQL示例：
    SELECT a.* FROM 表1 a, (select id from 表1 where 条件 LIMIT :page, :limit) b where a.id=b.id
    
    Parameters:
    
    countSql - 用于统计总数的sql语句 （注意：count(*)必须拥有count别名） 同时countSql可以为null表示不统计 可选参数
    
    querySql - 用于查询数据的sql语句
    
    pageIPO - 分页查询参数 PageIPO
    
    mappedClass - 映射类
    
    Returns:
    
    count（总数），data（分页列表数据）

Interface Dialect

Method Summary

Method Detail

dialectName

cloneDialect

getWrapper

setWrapper

getNamedParameterJdbcTemplate

setNamedParameterJdbcTemplate

getJdbcProperties

setJdbcProperties

insertOrUpdate

getPageJoinSql

toPage

page

pageWhere

pageSql

pageSql