org.dromara.hutool.db

Class DialectRunner

java.lang.Object

org.dromara.hutool.db.DialectRunner

All Implemented Interfaces:

Serializable

public class DialectRunner
extends Object
implements Serializable

提供基于方言的原始增删改查执行封装

Since:

5.5.3

Author:

looly

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DialectRunner(DbConfig config, Dialect dialect) 构造

Method Summary

Modifier and Type	Method and Description
long	count(Connection conn, Query query) 获取结果总数，生成类似于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
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
PageResult<Entity>	page(Connection conn, Query query) 分页查询 此方法不会关闭Connection
<T> T	page(Connection conn, Query query, RsHandler<T> rsh) 分页查询 此方法不会关闭Connection
PageResult<Entity>	page(Connection conn, SqlBuilder sqlBuilder, Page page) 分页查询 此方法不会关闭Connection
<T> T	page(Connection conn, SqlBuilder sqlBuilder, Page page, RsHandler<T> rsh) 分页查询 此方法不会关闭Connection
void	setWrapper(Character wrapperChar) 设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
void	setWrapper(QuoteWrapper quoteWrapper) 设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
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

Constructor Detail

DialectRunner

public DialectRunner(DbConfig config,
                     Dialect dialect)

构造

Parameters:

config - 数据库配置

dialect - 方言

Method Detail

insert

public int[] insert(Connection conn,
                    Entity... records)
             throws DbException

批量插入数据
批量插入必须严格保持Entity的结构一致，不一致会导致插入数据出现不可预知的结果
此方法不会关闭Connection

Parameters:

conn - 数据库连接

records - 记录列表，记录KV必须严格一致

Returns:

插入行数

Throws:

DbException - SQL执行异常

upsert

public int upsert(Connection conn,
                  Entity record,
                  String... keys)
           throws DbException

更新或插入数据
此方法不会关闭Connection 如果方言未实现此方法则内部自动使用insertOrUpdate来替代功能

Parameters:

conn - 数据库连接

record - 记录

keys - 需要检查唯一性的字段

Returns:

插入行数

Throws:

DbException - SQL执行异常

Since:

5.7.20

insertOrUpdate

public int insertOrUpdate(Connection conn,
                          Entity record,
                          String... keys)
                   throws DbException

插入或更新数据
此方法不会关闭Connection

Parameters:

conn - 数据库连接

record - 记录

keys - 需要检查唯一性的字段

Returns:

插入行数

Throws:

DbException - SQL执行异常

insert

public <T> T insert(Connection conn,
                    Entity record,
                    RsHandler<T> generatedKeysHandler)
             throws DbException

插入数据
此方法不会关闭Connection

Type Parameters:

T - 主键类型，可能为数字或对象列表

Parameters:

conn - 数据库连接

record - 记录

generatedKeysHandler - 自增主键处理器，用于定义返回自增主键的范围和类型

Returns:

主键列表

Throws:

DbException - SQL执行异常

del

public int del(Connection conn,
               Entity where)
        throws DbException

删除数据
此方法不会关闭Connection

Parameters:

conn - 数据库连接

where - 条件

Returns:

影响行数

Throws:

DbException - SQL执行异常

update

public int update(Connection conn,
                  Entity record,
                  Entity where)
           throws DbException

更新数据
此方法不会关闭Connection

Parameters:

conn - 数据库连接

record - 记录

where - 条件

Returns:

影响行数

Throws:

DbException - SQL执行异常

find

public <T> T find(Connection conn,
                  Query query,
                  RsHandler<T> rsh)
           throws DbException

查询
此方法不会关闭Connection

Type Parameters:

T - 结果对象类型

Parameters:

conn - 数据库连接对象

query - Query

rsh - 结果集处理对象

Returns:

结果对象

Throws:

DbException - SQL执行异常

count

public long count(Connection conn,
                  Query query)
           throws DbException

获取结果总数，生成类似于select count(1) from XXX wher XXX=? and YYY=?

Parameters:

conn - 数据库连接对象

query - 查询

Returns:

复合条件的结果数

Throws:

DbException - SQL执行异常

count

public long count(Connection conn,
                  SqlBuilder sqlBuilder)
           throws DbException

获取查询结果总数，生成类似于 SELECT count(1) from (sql) hutool_alias_count_
此方法会重新构建SqlBuilder，并去除末尾的order by子句

Parameters:

conn - 数据库连接对象

sqlBuilder - 查询语句

Returns:

复合条件的结果数

Throws:

DbException - SQL执行异常

Since:

5.7.2

page

public PageResult<Entity> page(Connection conn,
                               Query query)
                        throws DbException

分页查询
此方法不会关闭Connection

Parameters:

conn - 数据库连接对象

query - 查询

Returns:

结果对象

Throws:

DbException - SQL执行异常

page

public <T> T page(Connection conn,
                  Query query,
                  RsHandler<T> rsh)
           throws DbException

分页查询
此方法不会关闭Connection

Type Parameters:

T - 结果对象类型

Parameters:

conn - 数据库连接对象

query - 查询条件（包含表名）

rsh - 结果集处理对象

Returns:

结果对象

Throws:

DbException - SQL执行异常

page

public PageResult<Entity> page(Connection conn,
                               SqlBuilder sqlBuilder,
                               Page page)
                        throws DbException

分页查询
此方法不会关闭Connection

Parameters:

conn - 数据库连接对象

sqlBuilder - SQL构建器，可以使用SqlBuilder.of(CharSequence) 包装普通SQL

page - 分页对象

Returns:

结果对象

Throws:

DbException - SQL执行异常

page

public <T> T page(Connection conn,
                  SqlBuilder sqlBuilder,
                  Page page,
                  RsHandler<T> rsh)
           throws DbException

分页查询
此方法不会关闭Connection

Type Parameters:

T - 结果对象类型

Parameters:

conn - 数据库连接对象

sqlBuilder - SQL构建器，可以使用SqlBuilder.of(CharSequence) 包装普通SQL

page - 分页对象

rsh - 结果集处理对象

Returns:

结果对象

Throws:

DbException - SQL执行异常

Since:

5.5.3

setWrapper

public void setWrapper(Character wrapperChar)

设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突

Parameters:

wrapperChar - 包装字符，字符会在SQL生成时位于表名和字段名两边，null时表示取消包装

setWrapper

public void setWrapper(QuoteWrapper quoteWrapper)

设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突

Parameters:

quoteWrapper - 包装器，null表示取消包装