DialectRunner (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.db.DialectRunner

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SqlConnRunner
```
public class DialectRunner
extends Object
implements Serializable
```
提供基于方言的原始增删改查执行封装

Since:

5.5.3

Author:

looly

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected boolean caseInsensitive
是否大小写不敏感（默认大小写不敏感）

Fields
Modifier and Type	Field and Description
`protected boolean`	`caseInsensitive` 是否大小写不敏感（默认大小写不敏感）

Constructor Summary

Constructors
Constructor and Description

DialectRunner(Dialect dialect)
构造

DialectRunner(String driverClassName)
构造

Constructors
Constructor and Description
`DialectRunner(Dialect dialect)` 构造
`DialectRunner(String driverClassName)` 构造

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`count(Connection conn, Entity where)` 获取结果总数，生成类似于select count(1) from XXX wher XXX=?
`long`	`count(Connection conn, SqlBuilder sqlBuilder)` 获取查询结果总数，生成类似于 SELECT count(1) from (sql) hutool_alias_count_ 此方法会重新构建`SqlBuilder`，并去除末尾的order by子句
`int`	`del(Connection conn, Entity where)` 删除数据此方法不会关闭Connection
`<T> T`	`find(Connection conn, Query query, RsHandler<T> rsh)` 查询此方法不会关闭Connection
`Dialect`	`getDialect()`
`int[]`	`insert(Connection conn, Entity... records)` 批量插入数据批量插入必须严格保持Entity的结构一致，不一致会导致插入数据出现不可预知的结果此方法不会关闭Connection
`<T> T`	`insert(Connection conn, Entity record, RsHandler<T> generatedKeysHandler)` 插入数据此方法不会关闭Connection
`int`	`insertOrUpdate(Connection conn, Entity record, String... keys)` 插入或更新数据此方法不会关闭Connection
`<T> T`	`page(Connection conn, Query query, RsHandler<T> rsh)` 分页查询此方法不会关闭Connection
`<T> T`	`page(Connection conn, SqlBuilder sqlBuilder, Page page, RsHandler<T> rsh)` 分页查询此方法不会关闭Connection
`void`	`setCaseInsensitive(boolean caseInsensitive)` 设置是否在结果中忽略大小写如果忽略，则在Entity中调用getXXX时，字段值忽略大小写，默认忽略
`void`	`setDialect(Dialect dialect)` 设置SQL方言
`void`	`setWrapper(Character wrapperChar)` 设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
`void`	`setWrapper(Wrapper wrapper)` 设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
`int`	`update(Connection conn, Entity record, Entity where)` 更新数据此方法不会关闭Connection
`int`	`upsert(Connection conn, Entity record, String... keys)` 更新或插入数据此方法不会关闭Connection 如果方言未实现此方法则内部自动使用insertOrUpdate来替代功能

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

- Field Detail
  - caseInsensitive
```
protected boolean caseInsensitive
```
    是否大小写不敏感（默认大小写不敏感）
- Constructor Detail
  - DialectRunner
```
public DialectRunner(Dialect dialect)
```
    构造
    
    Parameters:
    
    dialect - 方言
  - DialectRunner
```
public DialectRunner(String driverClassName)
```
    构造
    
    Parameters:
    
    driverClassName - 驱动类名，用于识别方言
- Method Detail
  - insert
```
public int[] insert(Connection conn,
                    Entity... records)
             throws SQLException
```
    批量插入数据
    批量插入必须严格保持Entity的结构一致，不一致会导致插入数据出现不可预知的结果
    此方法不会关闭Connection
    
    Parameters:
    
    conn - 数据库连接
    
    records - 记录列表，记录KV必须严格一致
    
    Returns:
    
    插入行数
    
    Throws:
    
    SQLException - SQL执行异常
  - upsert
```
public int upsert(Connection conn,
                  Entity record,
                  String... keys)
           throws SQLException
```
    更新或插入数据
    此方法不会关闭Connection 如果方言未实现此方法则内部自动使用insertOrUpdate来替代功能
    
    Parameters:
    
    conn - 数据库连接
    
    record - 记录
    
    keys - 需要检查唯一性的字段
    
    Returns:
    
    插入行数
    
    Throws:
    
    SQLException - SQL执行异常
    
    Since:
    
    5.7.20
  - insertOrUpdate
```
public int insertOrUpdate(Connection conn,
                          Entity record,
                          String... keys)
                   throws SQLException
```
    插入或更新数据
    此方法不会关闭Connection
    
    Parameters:
    
    conn - 数据库连接
    
    record - 记录
    
    keys - 需要检查唯一性的字段
    
    Returns:
    
    插入行数
    
    Throws:
    
    SQLException - SQL执行异常
  - insert
```
public <T> T insert(Connection conn,
                    Entity record,
                    RsHandler<T> generatedKeysHandler)
             throws SQLException
```
    插入数据
    此方法不会关闭Connection
    
    Type Parameters:
    
    T - 主键类型，可能为数字或对象列表
    
    Parameters:
    
    conn - 数据库连接
    
    record - 记录
    
    generatedKeysHandler - 自增主键处理器，用于定义返回自增主键的范围和类型
    
    Returns:
    
    主键列表
    
    Throws:
    
    SQLException - SQL执行异常
  - del
```
public int del(Connection conn,
               Entity where)
        throws SQLException
```
    删除数据
    此方法不会关闭Connection
    
    Parameters:
    
    conn - 数据库连接
    
    where - 条件
    
    Returns:
    
    影响行数
    
    Throws:
    
    SQLException - SQL执行异常
  - update
```
public int update(Connection conn,
                  Entity record,
                  Entity where)
           throws SQLException
```
    更新数据
    此方法不会关闭Connection
    
    Parameters:
    
    conn - 数据库连接
    
    record - 记录
    
    where - 条件
    
    Returns:
    
    影响行数
    
    Throws:
    
    SQLException - SQL执行异常
  - find
```
public <T> T find(Connection conn,
                  Query query,
                  RsHandler<T> rsh)
           throws SQLException
```
    查询
    此方法不会关闭Connection
    
    Type Parameters:
    
    T - 结果对象类型
    
    Parameters:
    
    conn - 数据库连接对象
    
    query - Query
    
    rsh - 结果集处理对象
    
    Returns:
    
    结果对象
    
    Throws:
    
    SQLException - SQL执行异常
  - count
```
public long count(Connection conn,
                  Entity where)
           throws SQLException
```
    获取结果总数，生成类似于select count(1) from XXX wher XXX=? and YYY=?
    
    Parameters:
    
    conn - 数据库连接对象
    
    where - 查询条件
    
    Returns:
    
    复合条件的结果数
    
    Throws:
    
    SQLException - SQL执行异常
  - count
```
public long count(Connection conn,
                  SqlBuilder sqlBuilder)
           throws SQLException
```
    获取查询结果总数，生成类似于 SELECT count(1) from (sql) hutool_alias_count_
    此方法会重新构建SqlBuilder，并去除末尾的order by子句
    
    Parameters:
    
    conn - 数据库连接对象
    
    sqlBuilder - 查询语句
    
    Returns:
    
    复合条件的结果数
    
    Throws:
    
    SQLException - SQL执行异常
    
    Since:
    
    5.7.2
  - page
```
public <T> T page(Connection conn,
                  Query query,
                  RsHandler<T> rsh)
           throws SQLException
```
    分页查询
    此方法不会关闭Connection
    
    Type Parameters:
    
    T - 结果对象类型
    
    Parameters:
    
    conn - 数据库连接对象
    
    query - 查询条件（包含表名）
    
    rsh - 结果集处理对象
    
    Returns:
    
    结果对象
    
    Throws:
    
    SQLException - SQL执行异常
  - page
```
public <T> T page(Connection conn,
                  SqlBuilder sqlBuilder,
                  Page page,
                  RsHandler<T> rsh)
           throws SQLException
```
    分页查询
    此方法不会关闭Connection
    
    Type Parameters:
    
    T - 结果对象类型
    
    Parameters:
    
    conn - 数据库连接对象
    
    sqlBuilder - SQL构建器，可以使用SqlBuilder.of(CharSequence) 包装普通SQL
    
    page - 分页对象
    
    rsh - 结果集处理对象
    
    Returns:
    
    结果对象
    
    Throws:
    
    SQLException - SQL执行异常
    
    Since:
    
    5.5.3
  - setCaseInsensitive
```
public void setCaseInsensitive(boolean caseInsensitive)
```
    设置是否在结果中忽略大小写
    如果忽略，则在Entity中调用getXXX时，字段值忽略大小写，默认忽略
    
    Parameters:
    
    caseInsensitive - 否在结果中忽略大小写
    
    Since:
    
    5.2.4
  - getDialect
```
public Dialect getDialect()
```
    Returns:
    
    SQL方言
  - setDialect
```
public void setDialect(Dialect dialect)
```
    设置SQL方言
    
    Parameters:
    
    dialect - 方言
  - setWrapper
```
public void setWrapper(Character wrapperChar)
```
    设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
    
    Parameters:
    
    wrapperChar - 包装字符，字符会在SQL生成时位于表名和字段名两边，null时表示取消包装
  - setWrapper
```
public void setWrapper(Wrapper wrapper)
```
    设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
    
    Parameters:
    
    wrapper - 包装器，null表示取消包装

Class DialectRunner

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

caseInsensitive

Constructor Detail

DialectRunner

DialectRunner

Method Detail

insert

upsert

insertOrUpdate

insert

del

update

find

count

count

page

page

setCaseInsensitive

getDialect

setDialect

setWrapper

setWrapper