cn.hutool.db

Class DbUtil

java.lang.Object

cn.hutool.db.DbUtil

public final class DbUtil
extends Object

数据库操作工具类

Author:

Luxiaolei

Constructor Summary

Constructors

Constructor and Description
DbUtil()

Method Summary

Modifier and Type	Method and Description
static void	close(Object... objsToClose) 连续关闭一系列的SQL相关对象 这些对象必须按照顺序关闭，否则会出错。
static DataSource	getDs() 获得默认数据源
static DataSource	getDs(String group) 获取指定分组的数据源
static DataSource	getJndiDs(String jndiName) 获得JNDI数据源
static DataSource	getJndiDsWithLog(String jndiName) 获得JNDI数据源
static Session	newSession() 新建数据库会话，使用默认数据源
static Session	newSession(DataSource ds) 新建数据库会话
static SqlConnRunner	newSqlConnRunner(Connection conn) 实例化一个新的SQL运行对象
static SqlConnRunner	newSqlConnRunner(DataSource ds) 实例化一个新的SQL运行对象
static SqlConnRunner	newSqlConnRunner(Dialect dialect) 实例化一个新的SQL运行对象
static void	removeShowSqlParams(Setting setting) 移除配置文件中的Show SQL相关配置项 此方法用于移除用户配置在分组下的配置项目
static void	setCaseInsensitiveGlobal(boolean caseInsensitive) 设置全局是否在结果中忽略大小写 如果忽略，则在Entity中调用getXXX时，字段值忽略大小写，默认忽略
static void	setDbSettingPathGlobal(String dbSettingPath) 自定义数据库配置文件路径（绝对路径或相对classpath路径）
static void	setReturnGeneratedKeyGlobal(boolean returnGeneratedKey) 设置全局是否INSERT语句中默认返回主键（默认返回主键） 如果false，则在Insert操作后，返回影响行数 主要用于某些数据库不支持返回主键的情况
static void	setShowSqlGlobal(boolean isShowSql, boolean isFormatSql, boolean isShowParams, Level level) 设置全局配置：是否通过debug日志显示SQL
static void	setShowSqlGlobal(Setting setting) 从配置文件中读取SQL打印选项，读取后会去除相应属性
static Db	use() 实例化一个新的Db，使用默认数据源
static Db	use(DataSource ds) 实例化一个新的Db对象
static Db	use(DataSource ds, Dialect dialect) 实例化一个新的SQL运行对象

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbUtil

public DbUtil()

Method Detail

newSqlConnRunner

public static SqlConnRunner newSqlConnRunner(Dialect dialect)

实例化一个新的SQL运行对象

Parameters:

dialect - 数据源

Returns:

SQL执行类

newSqlConnRunner

public static SqlConnRunner newSqlConnRunner(DataSource ds)

实例化一个新的SQL运行对象

Parameters:

ds - 数据源

Returns:

SQL执行类

newSqlConnRunner

public static SqlConnRunner newSqlConnRunner(Connection conn)

实例化一个新的SQL运行对象

Parameters:

conn - 数据库连接对象

Returns:

SQL执行类

use

public static Db use()

实例化一个新的Db，使用默认数据源

Returns:

SQL执行类

use

public static Db use(DataSource ds)

实例化一个新的Db对象

Parameters:

ds - 数据源

Returns:

SQL执行类

use

public static Db use(DataSource ds,
                     Dialect dialect)

实例化一个新的SQL运行对象

Parameters:

ds - 数据源

dialect - SQL方言

Returns:

SQL执行类

newSession

public static Session newSession()

新建数据库会话，使用默认数据源

Returns:

数据库会话

newSession

public static Session newSession(DataSource ds)

新建数据库会话

Parameters:

ds - 数据源

Returns:

数据库会话

close

public static void close(Object... objsToClose)

连续关闭一系列的SQL相关对象
这些对象必须按照顺序关闭，否则会出错。

Parameters:

objsToClose - 需要关闭的对象

getDs

public static DataSource getDs()

获得默认数据源

Returns:

默认数据源

getDs

public static DataSource getDs(String group)

获取指定分组的数据源

Parameters:

group - 分组

Returns:

数据源

getJndiDsWithLog

public static DataSource getJndiDsWithLog(String jndiName)

获得JNDI数据源

Parameters:

jndiName - JNDI名称

Returns:

数据源

getJndiDs

public static DataSource getJndiDs(String jndiName)

获得JNDI数据源

Parameters:

jndiName - JNDI名称

Returns:

数据源

removeShowSqlParams

public static void removeShowSqlParams(Setting setting)

移除配置文件中的Show SQL相关配置项
此方法用于移除用户配置在分组下的配置项目

Parameters:

setting - 配置项

Since:

5.7.2

setShowSqlGlobal

public static void setShowSqlGlobal(Setting setting)

从配置文件中读取SQL打印选项，读取后会去除相应属性

Parameters:

setting - 配置文件

Since:

4.1.7

setShowSqlGlobal

public static void setShowSqlGlobal(boolean isShowSql,
                                    boolean isFormatSql,
                                    boolean isShowParams,
                                    Level level)

设置全局配置：是否通过debug日志显示SQL

Parameters:

isShowSql - 是否显示SQL

isFormatSql - 是否格式化显示的SQL

isShowParams - 是否打印参数

level - SQL打印到的日志等级

Since:

4.1.7

See Also:

GlobalDbConfig.setShowSql(boolean, boolean, boolean, Level)

setCaseInsensitiveGlobal

public static void setCaseInsensitiveGlobal(boolean caseInsensitive)

设置全局是否在结果中忽略大小写
如果忽略，则在Entity中调用getXXX时，字段值忽略大小写，默认忽略

Parameters:

caseInsensitive - 否在结果中忽略大小写

Since:

5.2.4

See Also:

GlobalDbConfig.setCaseInsensitive(boolean)

setReturnGeneratedKeyGlobal

public static void setReturnGeneratedKeyGlobal(boolean returnGeneratedKey)

设置全局是否INSERT语句中默认返回主键（默认返回主键）
如果false，则在Insert操作后，返回影响行数 主要用于某些数据库不支持返回主键的情况

Parameters:

returnGeneratedKey - 是否INSERT语句中默认返回主键

Since:

5.3.10

See Also:

GlobalDbConfig.setReturnGeneratedKey(boolean)

setDbSettingPathGlobal

public static void setDbSettingPathGlobal(String dbSettingPath)

自定义数据库配置文件路径（绝对路径或相对classpath路径）

Parameters:

dbSettingPath - 自定义数据库配置文件路径（绝对路径或相对classpath路径）

Since:

5.8.0

See Also:

GlobalDbConfig.setDbSettingPath(String)