SqlBuilder (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.db.sql.SqlBuilder

All Implemented Interfaces:

Builder<String>, Serializable
```
public class SqlBuilder
extends Object
implements Builder<String>
```
SQL构建器
首先拼接SQL语句，值使用 ? 占位
调用getParamValues()方法获得占位符对应的值

Author:

Looly

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SqlBuilder.Join
SQL中多表关联用的关键字

Nested Classes
Modifier and Type	Class and Description
`static class`	`SqlBuilder.Join` SQL中多表关联用的关键字

Constructor Summary

Constructors
Constructor and Description

SqlBuilder()

SqlBuilder(Wrapper wrapper)

Constructors
Constructor and Description
`SqlBuilder()`
`SqlBuilder(Wrapper wrapper)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SqlBuilder`	`addParams(Object... params)` 手动增加参数，调用此方法前需确认SQL中有对应占位符，主要用于自定义SQL片段中有占位符的情况，例如： SqlBuilder builder = SqlBuilder.of("select * from user where id=?")
`SqlBuilder`	`append(Object sqlFragment)` 追加SQL其它部分片段，此方法只是简单的追加SQL字符串，空格需手动加入，例如： SqlBuilder builder = SqlBuilder.of("select *"); builder.append(" from ").append("user"); 如果需要追加带占位符的片段，需调用`addParams(Object...)`
`String`	`build()` 构建，默认打印SQL日志
`static SqlBuilder`	`create()` 创建SQL构建器
`static SqlBuilder`	`create(Wrapper wrapper)` 创建SQL构建器
`SqlBuilder`	`delete(String tableName)` 删除
`SqlBuilder`	`format()` 格式化SQL语句
`SqlBuilder`	`from(String... tableNames)` 添加 from语句
`Object[]`	`getParamValueArray()` 获得占位符对应的值列表
`List<Object>`	`getParamValues()` 获得占位符对应的值列表
`SqlBuilder`	`groupBy(String... fields)` 分组
`SqlBuilder`	`having(Condition... conditions)` 添加Having语句，所有逻辑之间关系使用`Condition.setLinkOperator(LogicalOperator)` 定义
`SqlBuilder`	`having(String having)` 添加Having语句
`<T> SqlBuilder`	`in(String field, T... values)` 多值选择
`SqlBuilder`	`insert(Entity entity)` 插入，使用默认的ANSI方言
`SqlBuilder`	`insert(Entity entity, DialectName dialectName)` 插入插入会忽略空的字段名及其对应值，但是对于有字段名对应值为`null`的情况不忽略
`SqlBuilder`	`insert(Entity entity, String dialectName)` 插入插入会忽略空的字段名及其对应值，但是对于有字段名对应值为`null`的情况不忽略
`SqlBuilder`	`insertPreFragment(Object sqlFragment)` 在SQL的开头补充SQL片段
`SqlBuilder`	`join(String tableName, SqlBuilder.Join join)` 多表关联
`static SqlBuilder`	`of(CharSequence sql)` 从已有的SQL中构建一个SqlBuilder
`SqlBuilder`	`on(Condition... conditions)` 配合JOIN的 ON语句，多表关联的条件语句，所有逻辑之间关系使用`Condition.setLinkOperator(LogicalOperator)` 定义
`SqlBuilder`	`on(String on)` 配合JOIN的 ON语句，多表关联的条件语句只支持单一的逻辑运算符（例如多个条件之间）
`SqlBuilder`	`orderBy(Order... orders)` 排序
`SqlBuilder`	`query(Query query)` 构建查询SQL
`SqlBuilder`	`select(boolean isDistinct, Collection<String> fields)` 查询
`SqlBuilder`	`select(boolean isDistinct, String... fields)` 查询
`SqlBuilder`	`select(Collection<String> fields)` 查询（非Distinct）
`SqlBuilder`	`select(String... fields)` 查询（非Distinct）
`String`	`toString()`
`SqlBuilder`	`update(Entity entity)` 更新
`static void`	`validateEntity(Entity entity)` 验证实体类对象的有效性
`SqlBuilder`	`where(Condition... conditions)` 添加Where语句，所有逻辑之间关系使用`Condition.setLinkOperator(LogicalOperator)` 定义
`SqlBuilder`	`where(String where)` 添加Where语句

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

- Constructor Detail
  - SqlBuilder
```
public SqlBuilder()
```
  - SqlBuilder
```
public SqlBuilder(Wrapper wrapper)
```
- Method Detail
  - create
```
public static SqlBuilder create()
```
    创建SQL构建器
    
    Returns:
    
    SQL构建器
  - create
```
public static SqlBuilder create(Wrapper wrapper)
```
    创建SQL构建器
    
    Parameters:
    
    wrapper - 包装器
    
    Returns:
    
    SQL构建器
  - of
```
public static SqlBuilder of(CharSequence sql)
```
    从已有的SQL中构建一个SqlBuilder
    
    Parameters:
    
    sql - SQL语句
    
    Returns:
    
    SqlBuilder
    
    Since:
    
    5.5.3
  - validateEntity
```
public static void validateEntity(Entity entity)
                           throws DbRuntimeException
```
    验证实体类对象的有效性
    
    Parameters:
    
    entity - 实体类对象
    
    Throws:
    
    DbRuntimeException - SQL异常包装，获取元数据信息失败
  - insert
```
public SqlBuilder insert(Entity entity)
```
    插入，使用默认的ANSI方言
    
    Parameters:
    
    entity - 实体
    
    Returns:
    
    自己
  - insert
```
public SqlBuilder insert(Entity entity,
                         DialectName dialectName)
```
    插入
    插入会忽略空的字段名及其对应值，但是对于有字段名对应值为null的情况不忽略
    
    Parameters:
    
    entity - 实体
    
    dialectName - 方言名，用于对特殊数据库特殊处理
    
    Returns:
    
    自己
  - insert
```
public SqlBuilder insert(Entity entity,
                         String dialectName)
```
    插入
    插入会忽略空的字段名及其对应值，但是对于有字段名对应值为null的情况不忽略
    
    Parameters:
    
    entity - 实体
    
    dialectName - 方言名，用于对特殊数据库特殊处理
    
    Returns:
    
    自己
    
    Since:
    
    5.5.3
  - delete
```
public SqlBuilder delete(String tableName)
```
    删除
    
    Parameters:
    
    tableName - 表名
    
    Returns:
    
    自己
  - update
```
public SqlBuilder update(Entity entity)
```
    更新
    
    Parameters:
    
    entity - 要更新的实体
    
    Returns:
    
    自己
  - select
```
public SqlBuilder select(boolean isDistinct,
                         String... fields)
```
    查询
    
    Parameters:
    
    isDistinct - 是否添加DISTINCT关键字（查询唯一结果）
    
    fields - 查询的字段
    
    Returns:
    
    自己
  - select
```
public SqlBuilder select(boolean isDistinct,
                         Collection<String> fields)
```
    查询
    
    Parameters:
    
    isDistinct - 是否添加DISTINCT关键字（查询唯一结果）
    
    fields - 查询的字段
    
    Returns:
    
    自己
  - select
```
public SqlBuilder select(String... fields)
```
    查询（非Distinct）
    
    Parameters:
    
    fields - 查询的字段
    
    Returns:
    
    自己
  - select
```
public SqlBuilder select(Collection<String> fields)
```
    查询（非Distinct）
    
    Parameters:
    
    fields - 查询的字段
    
    Returns:
    
    自己
  - from
```
public SqlBuilder from(String... tableNames)
```
    添加 from语句
    
    Parameters:
    
    tableNames - 表名列表（多个表名用于多表查询）
    
    Returns:
    
    自己
  - where
```
public SqlBuilder where(Condition... conditions)
```
    添加Where语句，所有逻辑之间关系使用Condition.setLinkOperator(LogicalOperator) 定义
    
    Parameters:
    
    conditions - 条件，当条件为空时，只添加WHERE关键字
    
    Returns:
    
    自己
    
    Since:
    
    4.4.4
  - where
```
public SqlBuilder where(String where)
```
    添加Where语句
    
    Parameters:
    
    where - WHERE语句之后跟的条件语句字符串
    
    Returns:
    
    自己
  - in
```
public <T> SqlBuilder in(String field,
                         T... values)
```
    多值选择
    
    Type Parameters:
    
    T - 值类型
    
    Parameters:
    
    field - 字段名
    
    values - 值列表
    
    Returns:
    
    自身
  - groupBy
```
public SqlBuilder groupBy(String... fields)
```
    分组
    
    Parameters:
    
    fields - 字段
    
    Returns:
    
    自己
  - having
```
public SqlBuilder having(Condition... conditions)
```
    添加Having语句，所有逻辑之间关系使用Condition.setLinkOperator(LogicalOperator) 定义
    
    Parameters:
    
    conditions - 条件
    
    Returns:
    
    this
    
    Since:
    
    5.4.3
  - having
```
public SqlBuilder having(String having)
```
    添加Having语句
    
    Parameters:
    
    having - 条件语句
    
    Returns:
    
    自己
  - orderBy
```
public SqlBuilder orderBy(Order... orders)
```
    排序
    
    Parameters:
    
    orders - 排序对象
    
    Returns:
    
    自己
  - join
```
public SqlBuilder join(String tableName,
                       SqlBuilder.Join join)
```
    多表关联
    
    Parameters:
    
    tableName - 被关联的表名
    
    join - 内联方式
    
    Returns:
    
    自己
  - on
```
public SqlBuilder on(Condition... conditions)
```
    配合JOIN的 ON语句，多表关联的条件语句，所有逻辑之间关系使用Condition.setLinkOperator(LogicalOperator) 定义
    
    Parameters:
    
    conditions - 条件
    
    Returns:
    
    this
    
    Since:
    
    5.4.3
  - on
```
public SqlBuilder on(String on)
```
    配合JOIN的 ON语句，多表关联的条件语句
    只支持单一的逻辑运算符（例如多个条件之间）
    
    Parameters:
    
    on - 条件
    
    Returns:
    
    自己
  - insertPreFragment
```
public SqlBuilder insertPreFragment(Object sqlFragment)
```
    在SQL的开头补充SQL片段
    
    Parameters:
    
    sqlFragment - SQL片段
    
    Returns:
    
    this
    
    Since:
    
    4.1.3
  - append
```
public SqlBuilder append(Object sqlFragment)
```
    追加SQL其它部分片段，此方法只是简单的追加SQL字符串，空格需手动加入，例如：
```
     SqlBuilder builder = SqlBuilder.of("select *");
     builder.append(" from ").append("user");
 
```
    如果需要追加带占位符的片段，需调用addParams(Object...) 方法加入对应参数值。
    Parameters:
    
    sqlFragment - SQL其它部分片段
    
    Returns:
    
    this
  - addParams
```
public SqlBuilder addParams(Object... params)
```
    手动增加参数，调用此方法前需确认SQL中有对应占位符，主要用于自定义SQL片段中有占位符的情况，例如：
```
     SqlBuilder builder = SqlBuilder.of("select * from user where id=?");
     builder.append(" and name=?")
     builder.addParams(1, "looly");
 
```
    Parameters:
    
    params - 参数列表
    
    Returns:
    
    this
    
    Since:
    
    5.5.3
  - query
```
public SqlBuilder query(Query query)
```
    构建查询SQL
    
    Parameters:
    
    query - Query
    
    Returns:
    
    this
  - getParamValues
```
public List<Object> getParamValues()
```
    获得占位符对应的值列表
    
    Returns:
    
    占位符对应的值列表
  - getParamValueArray
```
public Object[] getParamValueArray()
```
    获得占位符对应的值列表
    
    Returns:
    
    占位符对应的值列表
  - build
```
public String build()
```
    构建，默认打印SQL日志
    
    Specified by:
    
    build in interface Builder<String>
    
    Returns:
    
    构建好的SQL语句
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - format
```
public SqlBuilder format()
```
    格式化SQL语句
    
    Returns:
    
    SqlBuilder

Class SqlBuilder

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SqlBuilder

SqlBuilder

Method Detail

create

create

of

validateEntity

insert

insert

insert

delete

update

select

select

select

select

from

where

where

in

groupBy

having

having

orderBy

join

on

on

insertPreFragment

append

addParams

query

getParamValues

getParamValueArray

build

toString

format