SqlConnRunner (hutool-db 4.6.0 API)

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

```
public class SqlConnRunner
extends Object
```
SQL执行类
此执行类只接受方言参数，不需要数据源，只有在执行方法时需要数据库连接对象
此对象存在的意义在于，可以由使用者自定义数据库连接对象，并执行多个方法，方便事务的统一控制或减少连接对象的创建关闭

作者:

Luxiaolei

构造器概要

构造器
构造器和说明

SqlConnRunner(Dialect dialect)
构造

SqlConnRunner(String driverClassName)
构造

构造器
构造器和说明
`SqlConnRunner(Dialect dialect)` 构造
`SqlConnRunner(String driverClassName)` 构造

方法概要

方法
限定符和类型	方法和说明
`int`	`count(Connection conn, Entity where)` 结果的条目数
`static SqlConnRunner`	`create(DataSource ds)` 实例化一个新的SQL运行对象
`static SqlConnRunner`	`create(Dialect dialect)` 实例化一个新的SQL运行对象
`static SqlConnRunner`	`create(String driverClassName)` 实例化一个新的SQL运行对象
`int`	`del(Connection conn, Entity where)` 删除数据此方法不会关闭Connection
`<T> T`	`find(Connection conn, Collection<String> fields, Entity where, RsHandler<T> rsh)` 查询此方法不会关闭Connection
`List<Entity>`	`find(Connection conn, Entity where)` 查询数据列表，返回字段在where参数中定义
`<T> T`	`find(Connection conn, Entity where, RsHandler<T> rsh, String... fields)` 查询，返回指定字段列表此方法不会关闭Connection
`<T> T`	`find(Connection conn, Query query, RsHandler<T> rsh)` 查询此方法不会关闭Connection
`List<Entity>`	`findAll(Connection conn, Entity where)` 查询数据列表，返回所有字段
`List<Entity>`	`findAll(Connection conn, String tableName)` 查询数据列表，返回所有字段
`List<Entity>`	`findBy(Connection conn, String tableName, String field, Object value)` 根据某个字段名条件查询数据列表，返回所有字段
`List<Entity>`	`findIn(Connection conn, String tableName, String field, Object... values)` 根据某个字段名条件查询数据列表，返回所有字段
`List<Entity>`	`findLike(Connection conn, String tableName, String field, String value, Condition.LikeType likeType)` 根据某个字段名条件查询数据列表，返回所有字段
`Dialect`	`getDialect()`
`int[]`	`insert(Connection conn, Collection<Entity> records)` 批量插入数据需要注意的是，批量插入每一条数据结构必须一致。
`int[]`	`insert(Connection conn, Entity... records)` 批量插入数据批量插入必须严格保持Entity的结构一致，不一致会导致插入数据出现不可预知的结果此方法不会关闭Connection
`int`	`insert(Connection conn, Entity record)` 插入数据此方法不会关闭Connection
`Long`	`insertForGeneratedKey(Connection conn, Entity record)` 插入数据此方法不会关闭Connection
`List<Object>`	`insertForGeneratedKeys(Connection conn, Entity record)` 插入数据此方法不会关闭Connection
`int`	`insertOrUpdate(Connection conn, Entity record, String... keys)` 插入数据此方法不会关闭Connection
`PageResult<Entity>`	`page(Connection conn, Collection<String> fields, Entity where, int page, int numPerPage)` 分页查询此方法不会关闭Connection
`<T> T`	`page(Connection conn, Collection<String> fields, Entity where, int pageNumber, int numPerPage, RsHandler<T> rsh)` 分页查询此方法不会关闭Connection
`PageResult<Entity>`	`page(Connection conn, Collection<String> fields, Entity where, Page page)` 分页查询此方法不会关闭Connection
`<T> T`	`page(Connection conn, Collection<String> fields, Entity where, Page page, RsHandler<T> rsh)` 分页查询此方法不会关闭Connection
`PageResult<Entity>`	`page(Connection conn, Entity where, Page page)` 分页全字段查询此方法不会关闭Connection
`SqlConnRunner`	`setDialect(Dialect dialect)` 设置SQL方言
`SqlConnRunner`	`setWrapper(Character wrapperChar)` 设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
`SqlConnRunner`	`setWrapper(Wrapper wrapper)` 设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
`int`	`update(Connection conn, Entity record, Entity where)` 更新数据此方法不会关闭Connection

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SqlConnRunner
```
public SqlConnRunner(Dialect dialect)
```
    构造
    
    参数:
    dialect - 方言
  - SqlConnRunner
```
public SqlConnRunner(String driverClassName)
```
    构造
    
    参数:
    driverClassName - 驱动类名，，用于识别方言
- 方法详细资料
  - create
```
public static SqlConnRunner create(Dialect dialect)
```
    实例化一个新的SQL运行对象
    
    参数:
    dialect - 方言
    
    返回:
    SQL执行类
  - create
```
public static SqlConnRunner create(DataSource ds)
```
    实例化一个新的SQL运行对象
    
    参数:
    ds - 数据源
    
    返回:
    SQL执行类
  - create
```
public static SqlConnRunner create(String driverClassName)
```
    实例化一个新的SQL运行对象
    
    参数:
    driverClassName - 驱动类名
    
    返回:
    SQL执行类
  - insert
```
public int insert(Connection conn,
         Entity record)
           throws SQLException
```
    插入数据
    此方法不会关闭Connection
    
    参数:
    conn - 数据库连接
    record - 记录
    
    返回:
    插入行数
    
    抛出:
    
    SQLException - SQL执行异常
  - insertOrUpdate
```
public int insertOrUpdate(Connection conn,
                 Entity record,
                 String... keys)
                   throws SQLException
```
    插入数据
    此方法不会关闭Connection
    
    参数:
    conn - 数据库连接
    record - 记录
    keys - 需要检查唯一性的字段
    
    返回:
    插入行数
    
    抛出:
    
    SQLException - SQL执行异常
  - insert
```
public int[] insert(Connection conn,
           Collection<Entity> records)
             throws SQLException
```
    批量插入数据
    需要注意的是，批量插入每一条数据结构必须一致。批量插入数据时会获取第一条数据的字段结构，之后的数据会按照这个格式插入。
    也就是说假如第一条数据只有2个字段，后边数据多于这两个字段的部分将被抛弃。此方法不会关闭Connection
    
    参数:
    conn - 数据库连接
    records - 记录列表，记录KV必须严格一致
    
    返回:
    插入行数
    
    抛出:
    
    SQLException - SQL执行异常
  - insert
```
public int[] insert(Connection conn,
           Entity... records)
             throws SQLException
```
    批量插入数据
    批量插入必须严格保持Entity的结构一致，不一致会导致插入数据出现不可预知的结果
    此方法不会关闭Connection
    
    参数:
    conn - 数据库连接
    records - 记录列表，记录KV必须严格一致
    
    返回:
    插入行数
    
    抛出:
    
    SQLException - SQL执行异常
  - insertForGeneratedKeys
```
public List<Object> insertForGeneratedKeys(Connection conn,
                                  Entity record)
                                    throws SQLException
```
    插入数据
    此方法不会关闭Connection
    
    参数:
    conn - 数据库连接
    record - 记录
    
    返回:
    主键列表
    
    抛出:
    
    SQLException - SQL执行异常
  - insertForGeneratedKey
```
public Long insertForGeneratedKey(Connection conn,
                         Entity record)
                           throws SQLException
```
    插入数据
    此方法不会关闭Connection
    
    参数:
    conn - 数据库连接
    record - 记录
    
    返回:
    自增主键
    
    抛出:
    
    SQLException - SQL执行异常
  - del
```
public int del(Connection conn,
      Entity where)
        throws SQLException
```
    删除数据
    此方法不会关闭Connection
    
    参数:
    conn - 数据库连接
    where - 条件
    
    返回:
    影响行数
    
    抛出:
    
    SQLException - SQL执行异常
  - update
```
public int update(Connection conn,
         Entity record,
         Entity where)
           throws SQLException
```
    更新数据
    此方法不会关闭Connection
    
    参数:
    conn - 数据库连接
    record - 记录
    where - 条件
    
    返回:
    影响行数
    
    抛出:
    
    SQLException - SQL执行异常
  - find
```
public <T> T find(Connection conn,
         Query query,
         RsHandler<T> rsh)
       throws SQLException
```
    查询
    此方法不会关闭Connection
    
    类型参数:
    T - 结果对象类型
    参数:
    conn - 数据库连接对象
    query - Query
    rsh - 结果集处理对象
    
    返回:
    结果对象
    
    抛出:
    
    SQLException - SQL执行异常
  - find
```
public <T> T find(Connection conn,
         Collection<String> fields,
         Entity where,
         RsHandler<T> rsh)
       throws SQLException
```
    查询
    此方法不会关闭Connection
    
    类型参数:
    T - 结果对象类型
    参数:
    conn - 数据库连接对象
    fields - 返回的字段列表，null则返回所有字段
    where - 条件实体类（包含表名）
    rsh - 结果集处理对象
    
    返回:
    结果对象
    
    抛出:
    
    SQLException - SQL执行异常
  - find
```
public <T> T find(Connection conn,
         Entity where,
         RsHandler<T> rsh,
         String... fields)
       throws SQLException
```
    查询，返回指定字段列表
    此方法不会关闭Connection
    
    类型参数:
    T - 结果对象类型
    参数:
    conn - 数据库连接对象
    where - 条件实体类（包含表名）
    rsh - 结果集处理对象
    fields - 字段列表，可变长参数如果无值表示查询全部字段
    
    返回:
    结果对象
    
    抛出:
    
    SQLException - SQL执行异常
  - find
```
public List<Entity> find(Connection conn,
                Entity where)
                  throws SQLException
```
    查询数据列表，返回字段在where参数中定义
    
    参数:
    conn - 数据库连接对象
    where - 条件实体类（包含表名）
    
    返回:
    数据对象列表
    
    抛出:
    
    SQLException - SQL执行异常
    从以下版本开始:
    
    3.2.1
  - findAll
```
public List<Entity> findAll(Connection conn,
                   Entity where)
                     throws SQLException
```
    查询数据列表，返回所有字段
    
    参数:
    conn - 数据库连接对象
    where - 条件实体类（包含表名）
    
    返回:
    数据对象列表
    
    抛出:
    
    SQLException - SQL执行异常
  - findAll
```
public List<Entity> findAll(Connection conn,
                   String tableName)
                     throws SQLException
```
    查询数据列表，返回所有字段
    
    参数:
    conn - 数据库连接对象
    tableName - 表名
    
    返回:
    数据对象列表
    
    抛出:
    
    SQLException - SQL执行异常
  - findBy
```
public List<Entity> findBy(Connection conn,
                  String tableName,
                  String field,
                  Object value)
                    throws SQLException
```
    根据某个字段名条件查询数据列表，返回所有字段
    
    参数:
    conn - 数据库连接对象
    tableName - 表名
    field - 字段名
    value - 字段值
    
    返回:
    数据对象列表
    
    抛出:
    
    SQLException - SQL执行异常
  - findLike
```
public List<Entity> findLike(Connection conn,
                    String tableName,
                    String field,
                    String value,
                    Condition.LikeType likeType)
                      throws SQLException
```
    根据某个字段名条件查询数据列表，返回所有字段
    
    参数:
    conn - 数据库连接对象
    tableName - 表名
    field - 字段名
    value - 字段值
    likeType - Condition.LikeType
    
    返回:
    数据对象列表
    
    抛出:
    
    SQLException - SQL执行异常
  - findIn
```
public List<Entity> findIn(Connection conn,
                  String tableName,
                  String field,
                  Object... values)
                    throws SQLException
```
    根据某个字段名条件查询数据列表，返回所有字段
    
    参数:
    conn - 数据库连接对象
    tableName - 表名
    field - 字段名
    values - 字段值列表
    
    返回:
    数据对象列表
    
    抛出:
    
    SQLException - SQL执行异常
  - count
```
public int count(Connection conn,
        Entity where)
          throws SQLException
```
    结果的条目数
    
    参数:
    conn - 数据库连接对象
    where - 查询条件
    
    返回:
    复合条件的结果数
    
    抛出:
    
    SQLException - SQL执行异常
  - page
```
public <T> T page(Connection conn,
         Collection<String> fields,
         Entity where,
         int pageNumber,
         int numPerPage,
         RsHandler<T> rsh)
       throws SQLException
```
    分页查询
    此方法不会关闭Connection
    
    类型参数:
    T - 结果对象类型
    参数:
    conn - 数据库连接对象
    fields - 返回的字段列表，null则返回所有字段
    where - 条件实体类（包含表名）
    pageNumber - 页码
    numPerPage - 每页条目数
    rsh - 结果集处理对象
    
    返回:
    结果对象
    
    抛出:
    
    SQLException - SQL执行异常
  - page
```
public <T> T page(Connection conn,
         Collection<String> fields,
         Entity where,
         Page page,
         RsHandler<T> rsh)
       throws SQLException
```
    分页查询
    此方法不会关闭Connection
    
    类型参数:
    T - 结果对象类型
    参数:
    conn - 数据库连接对象
    fields - 返回的字段列表，null则返回所有字段
    where - 条件实体类（包含表名）
    page - 分页对象
    rsh - 结果集处理对象
    
    返回:
    结果对象
    
    抛出:
    
    SQLException - SQL执行异常
  - page
```
public PageResult<Entity> page(Connection conn,
                      Collection<String> fields,
                      Entity where,
                      int page,
                      int numPerPage)
                        throws SQLException
```
    分页查询
    此方法不会关闭Connection
    
    参数:
    conn - 数据库连接对象
    fields - 返回的字段列表，null则返回所有字段
    where - 条件实体类（包含表名）
    page - 页码
    numPerPage - 每页条目数
    
    返回:
    结果对象
    
    抛出:
    
    SQLException - SQL执行异常
  - page
```
public PageResult<Entity> page(Connection conn,
                      Collection<String> fields,
                      Entity where,
                      Page page)
                        throws SQLException
```
    分页查询
    此方法不会关闭Connection
    
    参数:
    conn - 数据库连接对象
    fields - 返回的字段列表，null则返回所有字段
    where - 条件实体类（包含表名）
    page - 分页对象
    
    返回:
    结果对象
    
    抛出:
    
    SQLException - SQL执行异常
  - page
```
public PageResult<Entity> page(Connection conn,
                      Entity where,
                      Page page)
                        throws SQLException
```
    分页全字段查询
    此方法不会关闭Connection
    
    参数:
    conn - 数据库连接对象
    where - 条件实体类（包含表名）
    page - 分页对象
    
    返回:
    结果对象
    
    抛出:
    
    SQLException - SQL执行异常
  - getDialect
```
public Dialect getDialect()
```
    返回:
    SQL方言
  - setDialect
```
public SqlConnRunner setDialect(Dialect dialect)
```
    设置SQL方言
    
    参数:
    dialect - 方言
  - setWrapper
```
public SqlConnRunner setWrapper(Character wrapperChar)
```
    设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
    
    参数:
    wrapperChar - 包装字符，字符会在SQL生成时位于表名和字段名两边，null时表示取消包装
    
    返回:
    this
    从以下版本开始:
    
    4.0.0
  - setWrapper
```
public SqlConnRunner setWrapper(Wrapper wrapper)
```
    设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
    
    参数:
    wrapper - 包装器，null表示取消包装
    
    返回:
    this
    从以下版本开始:
    
    4.0.0

类 SqlConnRunner

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

SqlConnRunner

SqlConnRunner

方法详细资料

create

create

create

insert

insertOrUpdate

insert

insert

insertForGeneratedKeys

insertForGeneratedKey

del

update

find

find

find

find

findAll

findAll

findBy

findLike

findIn

count

page

page

page

page

page

getDialect

setDialect

setWrapper

setWrapper