Session (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.db.AbstractDb
- - cn.hutool.db.Session

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable
```
public class Session
extends AbstractDb
implements Closeable
```
数据库SQL执行会话
会话通过共用Connection而可以实现JDBC事务
一个会话只维护一个连接，推荐在执行完后关闭Session，避免重用
本对象并不是线程安全的，多个线程共用一个Session将会导致不可预知的问题

Author:

loolly

See Also:

Serialized Form

Field Summary
- Fields inherited from class cn.hutool.db.AbstractDb
  caseInsensitive, ds, isSupportTransaction, runner

Constructor Summary

Constructors
Constructor and Description
`Session(DataSource ds)` 构造，从DataSource中识别方言
`Session(DataSource ds, Dialect dialect)` 构造
`Session(DataSource ds, String driverClassName)` 构造

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`beginTransaction()` 开始事务
`void`	`close()`
`void`	`closeConnection(Connection conn)` 关闭连接自定义关闭连接有利于自定义回收连接机制，或者不关闭
`void`	`commit()` 提交事务
`static Session`	`create()` 创建默认数据源会话
`static Session`	`create(DataSource ds)` 创建会话
`static Session`	`create(String group)` 创建会话
`Session`	`disableWrapper()` 取消包装器取消自动添加到字段名、表名上的包装符（例如双引号）
`Connection`	`getConnection()` 获得链接。
`SqlConnRunner`	`getRunner()` 获得`SqlConnRunner`
`void`	`quietRollback()` 静默回滚事务回滚事务
`void`	`quietRollback(Savepoint savepoint)` 静默回滚到某个保存点，保存点的设置请使用setSavepoint方法
`void`	`rollback()` 回滚事务
`void`	`rollback(Savepoint savepoint)` 回滚到某个保存点，保存点的设置请使用setSavepoint方法
`Savepoint`	`setSavepoint()` 设置保存点
`Savepoint`	`setSavepoint(String name)` 设置保存点
`void`	`setTransactionIsolation(int level)` 设置事务的隔离级别 Connection.TRANSACTION_NONE 驱动不支持事务 Connection.TRANSACTION_READ_UNCOMMITTED 允许脏读、不可重复读和幻读 Connection.TRANSACTION_READ_COMMITTED 禁止脏读，但允许不可重复读和幻读 Connection.TRANSACTION_REPEATABLE_READ 禁止脏读和不可重复读，单运行幻读 Connection.TRANSACTION_SERIALIZABLE 禁止脏读、不可重复读和幻读
`Session`	`setWrapper(Character wrapperChar)` 设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
`Session`	`setWrapper(Wrapper wrapper)` 设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
`void`	`tx(VoidFunc1<Session> func)` 在事务中执行操作，通过实现`VoidFunc1`接口的call方法执行多条SQL语句从而完成事务

Methods inherited from class cn.hutool.db.AbstractDb
checkTransactionSupported, count, count, count, del, del, execute, executeBatch, executeBatch, executeBatch, executeBatch, executeForGeneratedKey, find, find, find, find, find, find, findAll, findAll, findAll, findBy, findBy, findLike, get, get, getDs, insert, insert, insertForGeneratedKey, insertForGeneratedKeys, insertOrUpdate, page, page, page, page, page, page, page, page, page, page, page, page, pageForEntityList, pageForEntityList, query, query, query, query, query, query, queryNumber, queryOne, queryString, setCaseInsensitive, setRunner, update, upsert

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

- Constructor Detail
  - Session
```
public Session(DataSource ds)
```
    构造，从DataSource中识别方言
    
    Parameters:
    
    ds - 数据源
  - Session
```
public Session(DataSource ds,
               String driverClassName)
```
    构造
    
    Parameters:
    
    ds - 数据源
    
    driverClassName - 数据库连接驱动类名，用于识别方言
  - Session
```
public Session(DataSource ds,
               Dialect dialect)
```
    构造
    
    Parameters:
    
    ds - 数据源
    
    dialect - 方言
- Method Detail
  - create
```
public static Session create()
```
    创建默认数据源会话
    
    Returns:
    
    Session
    
    Since:
    
    3.2.3
  - create
```
public static Session create(String group)
```
    创建会话
    
    Parameters:
    
    group - 分组
    
    Returns:
    
    Session
    
    Since:
    
    4.0.11
  - create
```
public static Session create(DataSource ds)
```
    创建会话
    
    Parameters:
    
    ds - 数据源
    
    Returns:
    
    Session
  - getRunner
```
public SqlConnRunner getRunner()
```
    获得SqlConnRunner
    
    Overrides:
    
    getRunner in class AbstractDb
    
    Returns:
    
    SqlConnRunner
  - beginTransaction
```
public void beginTransaction()
                      throws SQLException
```
    开始事务
    
    Throws:
    
    SQLException - SQL执行异常
  - commit
```
public void commit()
            throws SQLException
```
    提交事务
    
    Throws:
    
    SQLException - SQL执行异常
  - rollback
```
public void rollback()
              throws SQLException
```
    回滚事务
    
    Throws:
    
    SQLException - SQL执行异常
  - quietRollback
```
public void quietRollback()
```
    静默回滚事务
    回滚事务
  - rollback
```
public void rollback(Savepoint savepoint)
              throws SQLException
```
    回滚到某个保存点，保存点的设置请使用setSavepoint方法
    
    Parameters:
    
    savepoint - 保存点
    
    Throws:
    
    SQLException - SQL执行异常
  - quietRollback
```
public void quietRollback(Savepoint savepoint)
```
    静默回滚到某个保存点，保存点的设置请使用setSavepoint方法
    
    Parameters:
    
    savepoint - 保存点
  - setSavepoint
```
public Savepoint setSavepoint()
                       throws SQLException
```
    设置保存点
    
    Returns:
    
    保存点对象
    
    Throws:
    
    SQLException - SQL执行异常
  - setSavepoint
```
public Savepoint setSavepoint(String name)
                       throws SQLException
```
    设置保存点
    
    Parameters:
    
    name - 保存点的名称
    
    Returns:
    
    保存点对象
    
    Throws:
    
    SQLException - SQL执行异常
  - setTransactionIsolation
```
public void setTransactionIsolation(int level)
                             throws SQLException
```
    设置事务的隔离级别
    Connection.TRANSACTION_NONE 驱动不支持事务
    Connection.TRANSACTION_READ_UNCOMMITTED 允许脏读、不可重复读和幻读
    Connection.TRANSACTION_READ_COMMITTED 禁止脏读，但允许不可重复读和幻读
    Connection.TRANSACTION_REPEATABLE_READ 禁止脏读和不可重复读，单运行幻读
    Connection.TRANSACTION_SERIALIZABLE 禁止脏读、不可重复读和幻读
    
    Parameters:
    
    level - 隔离级别
    
    Throws:
    
    SQLException - SQL执行异常
  - tx
```
public void tx(VoidFunc1<Session> func)
        throws SQLException
```
    在事务中执行操作，通过实现VoidFunc1接口的call方法执行多条SQL语句从而完成事务
    
    Parameters:
    
    func - 函数抽象，在函数中执行多个SQL操作，多个操作会被合并为同一事务
    
    Throws:
    
    SQLException - SQL异常
    
    Since:
    
    3.2.3
  - setWrapper
```
public Session setWrapper(Character wrapperChar)
```
    Description copied from class: AbstractDb
    
    设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
    
    Overrides:
    
    setWrapper in class AbstractDb
    
    Parameters:
    
    wrapperChar - 包装字符，字符会在SQL生成时位于表名和字段名两边，null时表示取消包装
    
    Returns:
    
    this
  - setWrapper
```
public Session setWrapper(Wrapper wrapper)
```
    Description copied from class: AbstractDb
    
    设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
    
    Overrides:
    
    setWrapper in class AbstractDb
    
    Parameters:
    
    wrapper - 包装器，null表示取消包装
    
    Returns:
    
    this
  - disableWrapper
```
public Session disableWrapper()
```
    Description copied from class: AbstractDb
    
    取消包装器
    取消自动添加到字段名、表名上的包装符（例如双引号）
    
    Overrides:
    
    disableWrapper in class AbstractDb
    
    Returns:
    
    this
  - getConnection
```
public Connection getConnection()
                         throws SQLException
```
    Description copied from class: AbstractDb
    
    获得链接。根据实现不同，可以自定义获取连接的方式
    
    Specified by:
    
    getConnection in class AbstractDb
    
    Returns:
    
    Connection
    
    Throws:
    
    SQLException - 连接获取异常
  - closeConnection
```
public void closeConnection(Connection conn)
```
    Description copied from class: AbstractDb
    
    关闭连接
    自定义关闭连接有利于自定义回收连接机制，或者不关闭
    
    Specified by:
    
    closeConnection in class AbstractDb
    
    Parameters:
    
    conn - 连接 Connection
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable

Class Session

Field Summary

Fields inherited from class cn.hutool.db.AbstractDb

Constructor Summary

Method Summary

Methods inherited from class cn.hutool.db.AbstractDb

Methods inherited from class java.lang.Object

Constructor Detail

Session

Session

Session

Method Detail

create

create

create

getRunner

beginTransaction

commit

rollback

quietRollback

rollback

quietRollback

setSavepoint

setSavepoint

setTransactionIsolation

tx

setWrapper

setWrapper

disableWrapper

getConnection

closeConnection

close