Dialect (hutool 6.0.0-M20 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

AnsiSqlDialect, DmDialect, H2Dialect, MysqlDialect, OracleDialect, PhoenixDialect, PostgresqlDialect, Sqlite3Dialect, SqlServer2005Dialect, SqlServer2012Dialect
```
public interface Dialect
extends Serializable
```
SQL方言，不同的数据库由于在某些SQL上有所区别，故为每种数据库配置不同的方言。
由于不同数据库间SQL语句的差异，导致无法统一拼接SQL，
Dialect接口旨在根据不同的数据库，使用不同的方言实现类，来拼接对应的SQL，并将SQL和参数放入PreparedStatement中

Author:

loolly

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`String`	`dialectName()` 方言名
`QuoteWrapper`	`getWrapper()`
`default PreparedStatement`	`psForCount(Connection conn, Query query)` 构建用于查询行数的`PreparedStatement` 用户实现需按照数据库方言格式，将`Query`转换为带有占位符的SQL语句及参数列表 `Query`中包含了表名、查询条件等信息，可借助SqlBuilder完成SQL语句生成。
`default PreparedStatement`	`psForCount(Connection conn, SqlBuilder sqlBuilder)` 构建用于查询行数的`PreparedStatement` 用户实现需按照数据库方言格式，将`Query`转换为带有占位符的SQL语句及参数列表 `Query`中包含了表名、查询条件等信息，可借助SqlBuilder完成SQL语句生成。
`PreparedStatement`	`psForDelete(Connection conn, Query query)` 构建用于删除的`PreparedStatement` 用户实现需按照数据库方言格式，将`Query`转换为带有占位符的SQL语句及参数列表 `Query`中包含了删除所需的表名、查询条件等信息，可借助SqlBuilder完成SQL语句生成。
`PreparedStatement`	`psForFind(Connection conn, Query query)` 构建用于获取多条记录的`PreparedStatement` 用户实现需按照数据库方言格式，将`Query`转换为带有占位符的SQL语句及参数列表 `Query`中包含了查询所需的表名、查询条件等信息，可借助SqlBuilder完成SQL语句生成。
`PreparedStatement`	`psForInsert(boolean returnGeneratedKey, Connection conn, Entity entity)` 构建用于插入的`PreparedStatement` 用户实现需按照数据库方言格式，将`Entity`转换为带有占位符的SQL语句及参数列表
`PreparedStatement`	`psForInsertBatch(Connection conn, Entity... entities)` 构建用于批量插入的PreparedStatement 用户实现需按照数据库方言格式，将`Entity`转换为带有占位符的SQL语句及参数列表
`PreparedStatement`	`psForPage(Connection conn, Query query)` 构建用于分页查询的`PreparedStatement` 用户实现需按照数据库方言格式，将`Query`转换为带有占位符的SQL语句及参数列表 `Query`中包含了分页查询所需的表名、查询条件、分页等信息，可借助SqlBuilder完成SQL语句生成。
`PreparedStatement`	`psForPage(Connection conn, SqlBuilder sqlBuilder, Page page)` 构建用于分页查询的`PreparedStatement` 可以在此方法中使用`SqlBuilder.orderBy(Order...)`方法加入排序信息，排序信息通过`Page.getOrders()`获取
`PreparedStatement`	`psForUpdate(Connection conn, Entity entity, Query query)` 构建用于更新的`PreparedStatement` 用户实现需按照数据库方言格式，将`Entity`配合`Query`转换为带有占位符的SQL语句及参数列表其中`Entity`中包含需要更新的数据信息，`Query`包含更新的查找条件信息。
`PreparedStatement`	`psForUpsert(Connection conn, Entity entity, String... keys)` 构建用于upsert的`PreparedStatement` 方言实现需实现此默认方法，如果没有实现，抛出`DbException`
`void`	`setWrapper(QuoteWrapper quoteWrapper)` 设置包装器

- Method Detail
  - dialectName
```
String dialectName()
```
    方言名
    
    Returns:
    
    方言名
    
    Since:
    
    5.5.3
  - getWrapper
```
QuoteWrapper getWrapper()
```
    Returns:
    
    包装器
  - setWrapper
```
void setWrapper(QuoteWrapper quoteWrapper)
```
    设置包装器
    
    Parameters:
    
    quoteWrapper - 包装器
  - psForInsert
```
PreparedStatement psForInsert(boolean returnGeneratedKey,
                              Connection conn,
                              Entity entity)
                       throws DbException
```
    构建用于插入的PreparedStatement
    用户实现需按照数据库方言格式，将Entity转换为带有占位符的SQL语句及参数列表
    
    Parameters:
    
    returnGeneratedKey - 是否返回自增主键
    
    conn - 数据库连接对象
    
    entity - 数据实体类（包含表名）
    
    Returns:
    
    PreparedStatement
    
    Throws:
    
    DbException - SQL执行异常
  - psForInsertBatch
```
PreparedStatement psForInsertBatch(Connection conn,
                                   Entity... entities)
                            throws DbException
```
    构建用于批量插入的PreparedStatement
    用户实现需按照数据库方言格式，将Entity转换为带有占位符的SQL语句及参数列表
    
    Parameters:
    
    conn - 数据库连接对象
    
    entities - 数据实体，实体的结构必须全部一致，否则插入结果将不可预知
    
    Returns:
    
    PreparedStatement
    
    Throws:
    
    DbException - SQL执行异常
  - psForDelete
```
PreparedStatement psForDelete(Connection conn,
                              Query query)
                       throws DbException
```
    构建用于删除的PreparedStatement
    用户实现需按照数据库方言格式，将Query转换为带有占位符的SQL语句及参数列表
    Query中包含了删除所需的表名、查询条件等信息，可借助SqlBuilder完成SQL语句生成。
    
    Parameters:
    
    conn - 数据库连接对象
    
    query - 查找条件（包含表名）
    
    Returns:
    
    PreparedStatement
    
    Throws:
    
    DbException - SQL执行异常
  - psForUpdate
```
PreparedStatement psForUpdate(Connection conn,
                              Entity entity,
                              Query query)
                       throws DbException
```
    构建用于更新的PreparedStatement
    用户实现需按照数据库方言格式，将Entity配合Query转换为带有占位符的SQL语句及参数列表
    其中Entity中包含需要更新的数据信息，Query包含更新的查找条件信息。
    
    Parameters:
    
    conn - 数据库连接对象
    
    entity - 数据实体类（包含表名）
    
    query - 查找条件（包含表名）
    
    Returns:
    
    PreparedStatement
    
    Throws:
    
    DbException - SQL执行异常
  - psForUpsert
```
PreparedStatement psForUpsert(Connection conn,
                              Entity entity,
                              String... keys)
                       throws DbException
```
    构建用于upsert的PreparedStatement
    方言实现需实现此默认方法，如果没有实现，抛出DbException
    
    Parameters:
    
    conn - 数据库连接对象
    
    entity - 数据实体类（包含表名）
    
    keys - 查找字段，某些数据库此字段必须，如H2，某些数据库无需此字段，如MySQL（通过主键）
    
    Returns:
    
    PreparedStatement
    
    Throws:
    
    DbException - SQL执行异常，或方言数据不支持此操作
    
    Since:
    
    5.7.20
  - psForFind
```
PreparedStatement psForFind(Connection conn,
                            Query query)
                     throws DbException
```
    构建用于获取多条记录的PreparedStatement
    用户实现需按照数据库方言格式，将Query转换为带有占位符的SQL语句及参数列表
    Query中包含了查询所需的表名、查询条件等信息，可借助SqlBuilder完成SQL语句生成。
    
    Parameters:
    
    conn - 数据库连接对象
    
    query - 查询条件（包含表名）
    
    Returns:
    
    PreparedStatement
    
    Throws:
    
    DbException - SQL执行异常
  - psForPage
```
PreparedStatement psForPage(Connection conn,
                            Query query)
                     throws DbException
```
    构建用于分页查询的PreparedStatement
    用户实现需按照数据库方言格式，将Query转换为带有占位符的SQL语句及参数列表
    Query中包含了分页查询所需的表名、查询条件、分页等信息，可借助SqlBuilder完成SQL语句生成。
    
    Parameters:
    
    conn - 数据库连接对象
    
    query - 查询条件（包含表名）
    
    Returns:
    
    PreparedStatement
    
    Throws:
    
    DbException - SQL执行异常
  - psForPage
```
PreparedStatement psForPage(Connection conn,
                            SqlBuilder sqlBuilder,
                            Page page)
                     throws DbException
```
    构建用于分页查询的PreparedStatement
    可以在此方法中使用SqlBuilder.orderBy(Order...)方法加入排序信息，排序信息通过Page.getOrders()获取
    
    Parameters:
    
    conn - 数据库连接对象
    
    sqlBuilder - SQL构建器，可以使用SqlBuilder.of(CharSequence) 包装普通SQL
    
    page - 分页对象
    
    Returns:
    
    PreparedStatement
    
    Throws:
    
    DbException - SQL执行异常
    
    Since:
    
    5.5.3
  - psForCount
```
default PreparedStatement psForCount(Connection conn,
                                     Query query)
                              throws DbException
```
    构建用于查询行数的PreparedStatement
    用户实现需按照数据库方言格式，将Query转换为带有占位符的SQL语句及参数列表
    Query中包含了表名、查询条件等信息，可借助SqlBuilder完成SQL语句生成。
    
    Parameters:
    
    conn - 数据库连接对象
    
    query - 查询条件（包含表名）
    
    Returns:
    
    PreparedStatement
    
    Throws:
    
    DbException - SQL执行异常
  - psForCount
```
default PreparedStatement psForCount(Connection conn,
                                     SqlBuilder sqlBuilder)
                              throws DbException
```
    构建用于查询行数的PreparedStatement
    用户实现需按照数据库方言格式，将Query转换为带有占位符的SQL语句及参数列表
    Query中包含了表名、查询条件等信息，可借助SqlBuilder完成SQL语句生成。
    
    Parameters:
    
    conn - 数据库连接对象
    
    sqlBuilder - 查询语句，应该包含分页等信息
    
    Returns:
    
    PreparedStatement
    
    Throws:
    
    DbException - SQL执行异常
    
    Since:
    
    5.7.2

Interface Dialect

Method Summary

Method Detail

dialectName

getWrapper

setWrapper

psForInsert

psForInsertBatch

psForDelete

psForUpdate

psForUpsert

psForFind

psForPage

psForPage

psForCount

psForCount