AnsiSqlDialect (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.db.dialect.impl.AnsiSqlDialect

All Implemented Interfaces:

Serializable, Dialect

Direct Known Subclasses:

DmDialect, H2Dialect, MysqlDialect, OracleDialect, PhoenixDialect, PostgresqlDialect, Sqlite3Dialect, SqlServer2005Dialect, SqlServer2012Dialect
```
public class AnsiSqlDialect
extends Object
implements Dialect
```
ANSI SQL 方言

Author:

loolly

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected DbConfig dbConfig

protected QuoteWrapper quoteWrapper

Fields
Modifier and Type	Field and Description
`protected DbConfig`	`dbConfig`
`protected QuoteWrapper`	`quoteWrapper`

Constructor Summary

Constructors
Constructor and Description

AnsiSqlDialect(DbConfig dbConfig)
构造

Constructors
Constructor and Description
`AnsiSqlDialect(DbConfig dbConfig)` 构造

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`dialectName()` 方言名
`QuoteWrapper`	`getWrapper()`
`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)` 设置包装器
`protected SqlBuilder`	`wrapPageSql(SqlBuilder find, Page page)` 根据不同数据库在查询SQL语句基础上包装其分页的语句各自数据库通过重写此方法实现最小改动情况下修改分页语句

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dromara.hutool.db.dialect.Dialect
psForCount, psForCount

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

Class AnsiSqlDialect

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.dromara.hutool.db.dialect.Dialect

Field Detail

dbConfig

quoteWrapper

Constructor Detail

AnsiSqlDialect

Method Detail

getWrapper

setWrapper

psForInsert

psForInsertBatch

psForDelete

psForUpdate

psForUpsert

psForFind

psForPage

psForPage

wrapPageSql

dialectName