EntityStatements (polaris-toolkit 3.5.10 API)

java.lang.Object
- io.polaris.core.jdbc.sql.EntityStatements

public class EntityStatements
extends Object

从以下版本开始:: Jan 27, 2024
作者:: Qt

字段概要

字段
限定符和类型字段和说明

static String DEFAULT_TABLE_ALIAS

字段
限定符和类型	字段和说明
`static String`	`DEFAULT_TABLE_ALIAS`

构造器概要

构造器
构造器和说明

EntityStatements()

构造器
构造器和说明
`EntityStatements()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static TableAccessible`	`asTableAccessible(SqlEntity sqlEntityDeclared)` 将SqlEntity转换为TableAccessible对象
`static SqlNodeBuilder`	`buildDelete(Map<String,Object> bindings, Class<?> entityClass, String tableAlias, boolean byId, String entityKey, String whereKey, ColumnPredicate columnPredicate, boolean logicDeleted)` 构建 DELETE 或 UPDATE（逻辑删除时）SQL 语句的 SqlNodeBuilder。
`static SqlNodeBuilder`	`buildDelete(Map<String,Object> bindings, EntityDelete entityDelete)` 构建删除SQL节点构建器
`static InsertStatement<?>`	`buildInsert(Map<String,Object> bindings, Class<?> entityClass, String entityKey, boolean enableReplace, boolean enableUpdateByDuplicateKey, ColumnPredicate predicate)` 构建插入语句的工厂方法
`static InsertStatement<?>`	`buildInsert(Map<String,Object> bindings, Class<?> entityClass, String entityKey, boolean enableReplace, boolean enableUpdateByDuplicateKey, ColumnPredicate columnPredicate)` 构建插入语句对象
`static InsertStatement<?>`	`buildInsert(Map<String,Object> bindings, EntityInsert entityInsert)` 构建插入语句的工厂方法
`static MergeStatement<?>`	`buildMerge(Map<String,Object> bindings, Class<?> entityClass, String tableAlias, String entityKey, boolean updateWhenMatched, boolean insertWhenNotMatched, ColumnPredicate predicate)` 构建Merge语句对象
`static MergeStatement<?>`	`buildMerge(Map<String,Object> bindings, Class<?> entityClass, String tableAlias, String entityKey, boolean updateWhenMatched, boolean insertWhenNotMatched, ColumnPredicate columnPredicate)` 构建MergeStatement对象的工厂方法
`static MergeStatement<?>`	`buildMerge(Map<String,Object> bindings, EntityMerge entityMerge)` 构建合并语句对象
`static SelectStatement<?>`	`buildSelect(Map<String,Object> bindings, Class<?> entityClass, String tableAlias, boolean byId, String entityKey, String whereKey, String orderByKey, ColumnPredicate columnPredicate, boolean exceptLogicDeleted)` 构建一个 SelectStatement 对象，用于执行数据库查询操作。
`static SelectStatement<?>`	`buildSelect(Map<String,Object> bindings, EntitySelect entitySelect)` 构建SELECT语句对象
`static SqlNodeBuilder`	`buildSqlDelete(Map<String,Object> bindings, SqlDelete sqlDelete)` 构建SQL删除语句的SqlNodeBuilder
`static InsertStatement<?>`	`buildSqlInsert(Map<String,Object> bindings, SqlInsert sqlInsert)` 构建SQL插入语句
`static Function<Map<String,Object>,SqlNode>`	`buildSqlRawFunction(Method method)` 构建一个原始 SQL 函数，用于根据方法上的注解生成对应的 `SqlNode`。
`static SelectStatement<?>`	`buildSqlSelect(Map<String,Object> bindings, SqlSelect sqlSelect)` 构建SQL SELECT语句
`static Function<Map<String,Object>,SqlNode>`	`buildSqlSelectFunction(Method method)` 构建SQL查询函数
`static SetOpsStatement<?>`	`buildSqlSelectSet(Map<String,Object> bindings, SqlSelectSet sqlSelectSet)` 根据给定的绑定变量和 SqlSelectSet 构建一个 SetOpsStatement 对象。
`static UpdateStatement<?>`	`buildSqlUpdate(Map<String,Object> bindings, SqlUpdate sqlUpdate)` 构建SQL更新语句
`static Function<Map<String,Object>,SqlNode>`	`buildSqlUpdateFunction(Method method)` 根据方法上的注解构建对应的 SQL 更新函数。
`static UpdateStatement<?>`	`buildUpdate(Map<String,Object> bindings, Class<?> entityClass, String tableAlias, boolean byId, String entityKey, String whereKey, ColumnPredicate predicate, ColumnPredicate wherePredicate)` 构建更新语句的静态方法
`static UpdateStatement<?>`	`buildUpdate(Map<String,Object> bindings, Class<?> entityClass, String tableAlias, boolean byId, String entityKey, String whereKey, ColumnPredicate columnPredicate, ColumnPredicate whereColumnPredicate)` 构建更新语句
`static UpdateStatement<?>`	`buildUpdate(Map<String,Object> bindings, EntityUpdate entityUpdate)` 构建更新语句
`static TableMeta`	`getTableMeta(String entityClassName)` 根据实体类名称获取对应的表元数据信息

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

- 字段详细资料
  - DEFAULT_TABLE_ALIAS
```
public static final String DEFAULT_TABLE_ALIAS
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - EntityStatements
```
public EntityStatements()
```
- 方法详细资料
  - getTableMeta
```
public static TableMeta getTableMeta(String entityClassName)
```
    根据实体类名称获取对应的表元数据信息
    
    参数:
    
    entityClassName - 实体类的全限定名
    
    返回:
    
    表元数据对象，如果未找到则返回null
  - asTableAccessible
```
public static TableAccessible asTableAccessible(SqlEntity sqlEntityDeclared)
```
    将SqlEntity转换为TableAccessible对象
    
    参数:
    
    sqlEntityDeclared - SQL实体声明对象，用于获取表信息和别名信息
    
    返回:
    
    返回封装了表段信息的TableAccessible对象，如果输入为空或无法构建则返回null
  - buildSqlUpdateFunction
```
public static Function<Map<String,Object>,SqlNode> buildSqlUpdateFunction(Method method)
```
    根据方法上的注解构建对应的 SQL 更新函数。
    该方法会检查方法上是否存在特定的注解（如 EntityInsert、EntityDelete 等），并根据找到的第一个匹配注解构建相应的 SQL 语句生成函数。如果没有找到任何已知注解，则回退到原始 SQL 函数构建逻辑。
    
    参数:
    
    method - 要检查和处理的方法对象，不能为 null
    
    返回:
    
    一个函数，接受绑定参数映射并返回对应的 SqlNode 对象；如果未找到匹配注解，则返回原始 SQL 构建函数
  - buildSqlSelectFunction
```
public static Function<Map<String,Object>,SqlNode> buildSqlSelectFunction(Method method)
```
    构建SQL查询函数
    
    参数:
    
    method - 方法对象，用于获取注解信息
    
    返回:
    
    返回一个函数，该函数接收Map类型的参数bindings，并返回SqlNode类型的SQL节点对象
  - buildSqlRawFunction
```
public static Function<Map<String,Object>,SqlNode> buildSqlRawFunction(Method method)
```
    构建一个原始 SQL 函数，用于根据方法上的注解生成对应的 SqlNode。
    支持以下几种情况：
    - 如果方法上存在 SqlRawSimple 注解，则解析其定义的 SQL 文本，并可选地处理表引用。
    - 如果方法上存在 SqlRaw 注解，则使用更复杂的模型构建 SQL 节点。
    - 如果没有找到上述注解，则尝试从绑定参数中获取 SQL 内容（通过 BindingKeys.SQL）。
    参数:
    
    method - 方法对象，应包含 SQL 相关注解
    
    返回:
    
    返回一个函数，该函数接收变量绑定映射并返回对应的 SqlNode
  - buildSqlInsert
```
public static InsertStatement<?> buildSqlInsert(Map<String,Object> bindings,
                                                SqlInsert sqlInsert)
```
    构建SQL插入语句
    
    参数:
    
    bindings - 包含绑定值的映射表，用于获取字段的具体值
    
    sqlInsert - SQL插入注解，包含表信息、列信息和插入选项
    
    返回:
    
    构建好的插入语句对象
  - buildSqlDelete
```
public static SqlNodeBuilder buildSqlDelete(Map<String,Object> bindings,
                                            SqlDelete sqlDelete)
```
    构建SQL删除语句的SqlNodeBuilder
    
    参数:
    
    bindings - 参数绑定映射表，用于存储SQL参数绑定信息
    
    sqlDelete - 删除注解对象，包含删除操作的相关配置信息
    
    返回:
    
    返回构建好的SqlNodeBuilder实例，可以是UpdateStatement或DeleteStatement
    
    抛出:
    
    IllegalArgumentException - 当实体类型为空时抛出异常
  - buildSqlUpdate
```
public static UpdateStatement<?> buildSqlUpdate(Map<String,Object> bindings,
                                                SqlUpdate sqlUpdate)
```
    构建SQL更新语句
    
    参数:
    
    bindings - 绑定参数映射，用于获取列更新值和WHERE条件值
    
    sqlUpdate - SQL更新注解，包含表信息、列信息和WHERE条件信息
    
    返回:
    
    构建好的更新语句对象
  - buildSqlSelectSet
```
public static SetOpsStatement<?> buildSqlSelectSet(Map<String,Object> bindings,
                                                   SqlSelectSet sqlSelectSet)
```
    根据给定的绑定变量和 SqlSelectSet 构建一个 SetOpsStatement 对象。该方法会根据条件筛选出有效的 SqlSelect 项，并按照指定的集合操作（如 UNION、INTERSECT 等）组合成最终的查询语句。
    
    参数:
    
    bindings - 绑定变量映射，用于条件判断和 SQL 构建
    
    sqlSelectSet - 包含多个 SQL 查询项及其条件与操作符的集合定义
    
    返回:
    
    构建完成的 SetOpsStatement 查询对象，如果没有任何有效项则可能返回 null
  - buildSqlSelect
```
public static SelectStatement<?> buildSqlSelect(Map<String,Object> bindings,
                                                SqlSelect sqlSelect)
```
    构建SQL SELECT语句
    
    参数:
    
    bindings - 参数绑定映射，用于替换SQL中的占位符
    
    sqlSelect - SQL SELECT语句定义对象
    
    返回:
    
    构建好的SelectStatement对象，可用于执行查询
  - buildInsert
```
public static InsertStatement<?> buildInsert(Map<String,Object> bindings,
                                             EntityInsert entityInsert)
```
    构建插入语句的工厂方法
    
    参数:
    
    bindings - 参数绑定映射表，用于存储列名和对应值的映射关系
    
    entityInsert - 实体插入配置对象，包含表名、实体键等插入相关信息
    
    返回:
    
    返回构建好的插入语句对象
  - buildInsert
```
public static InsertStatement<?> buildInsert(Map<String,Object> bindings,
                                             Class<?> entityClass,
                                             String entityKey,
                                             boolean enableReplace,
                                             boolean enableUpdateByDuplicateKey,
                                             ColumnPredicate predicate)
```
    构建插入语句的工厂方法
    
    参数:
    
    bindings - 参数绑定映射，用于存储列名和对应的值
    
    entityClass - 实体类的Class对象，表示要操作的数据库表对应的实体类
    
    entityKey - 实体键标识，用于区分不同的实体实例
    
    enableReplace - 是否启用替换模式，当为true时允许替换已存在的记录
    
    enableUpdateByDuplicateKey - 是否启用重复键更新模式，当为true时在遇到重复键时执行更新操作
    
    predicate - 列过滤谓词，用于决定哪些列应该包含在插入语句中
    
    返回:
    
    返回构建好的插入语句对象
  - buildInsert
```
public static InsertStatement<?> buildInsert(Map<String,Object> bindings,
                                             Class<?> entityClass,
                                             String entityKey,
                                             boolean enableReplace,
                                             boolean enableUpdateByDuplicateKey,
                                             ColumnPredicate columnPredicate)
```
    构建插入语句对象
    
    参数:
    
    bindings - 参数绑定映射表，用于获取实体对象
    
    entityClass - 实体类的Class对象，指定要插入的数据类型
    
    entityKey - 实体在bindings中的键名
    
    enableReplace - 是否启用替换模式
    
    enableUpdateByDuplicateKey - 是否启用重复键更新模式
    
    columnPredicate - 列过滤谓词，用于筛选需要处理的列
    
    返回:
    
    构建好的插入语句对象
  - buildDelete
```
public static SqlNodeBuilder buildDelete(Map<String,Object> bindings,
                                         EntityDelete entityDelete)
```
    构建删除SQL节点构建器
    
    参数:
    
    bindings - 参数绑定映射表，用于存储SQL参数绑定信息
    
    entityDelete - 实体删除对象，包含删除操作的相关配置信息
    
    返回:
    
    SqlNodeBuilder SQL节点构建器，用于构建删除SQL语句
  - buildDelete
```
public static SqlNodeBuilder buildDelete(Map<String,Object> bindings,
                                         Class<?> entityClass,
                                         String tableAlias,
                                         boolean byId,
                                         String entityKey,
                                         String whereKey,
                                         ColumnPredicate columnPredicate,
                                         boolean logicDeleted)
```
    构建 DELETE 或 UPDATE（逻辑删除时）SQL 语句的 SqlNodeBuilder。
    
    参数:
    
    bindings - 参数绑定映射，用于获取实体或条件对象
    
    entityClass - 实体类，表示要操作的表对应的 Java 类型
    
    tableAlias - 表别名，若为空则使用默认别名
    
    byId - 是否根据主键 ID 删除/更新
    
    entityKey - 实体参数在 bindings 中的键名
    
    whereKey - 条件参数在 bindings 中的键名
    
    columnPredicate - 列过滤谓词，决定哪些列参与 WHERE 条件构建
    
    logicDeleted - 是否启用逻辑删除模式
    
    返回:
    
    返回构建好的 SqlNodeBuilder 实例（DeleteStatement 或 UpdateStatement）
  - buildUpdate
```
public static UpdateStatement<?> buildUpdate(Map<String,Object> bindings,
                                             EntityUpdate entityUpdate)
```
    构建更新语句
    
    参数:
    
    bindings - 参数绑定映射表，用于存储SQL参数绑定
    
    entityUpdate - 实体更新对象，包含更新操作的相关信息
    
    返回:
    
    返回构建好的更新语句对象
  - buildUpdate
```
public static UpdateStatement<?> buildUpdate(Map<String,Object> bindings,
                                             Class<?> entityClass,
                                             String tableAlias,
                                             boolean byId,
                                             String entityKey,
                                             String whereKey,
                                             ColumnPredicate predicate,
                                             ColumnPredicate wherePredicate)
```
    构建更新语句的静态方法
    
    参数:
    
    bindings - 参数绑定映射，用于存储SQL参数值
    
    entityClass - 实体类的Class对象，表示要更新的实体类型
    
    tableAlias - 表别名，用于在SQL中引用表
    
    byId - 是否通过ID进行更新的标识
    
    entityKey - 实体键，用于标识实体的主键字段
    
    whereKey - 条件键，用于构建WHERE子句的条件字段
    
    predicate - 列断言对象，定义更新字段的条件
    
    wherePredicate - WHERE子句列断言对象，定义WHERE条件的约束
    
    返回:
    
    返回构建好的更新语句对象
  - buildUpdate
```
public static UpdateStatement<?> buildUpdate(Map<String,Object> bindings,
                                             Class<?> entityClass,
                                             String tableAlias,
                                             boolean byId,
                                             String entityKey,
                                             String whereKey,
                                             ColumnPredicate columnPredicate,
                                             ColumnPredicate whereColumnPredicate)
```
    构建更新语句
    
    参数:
    
    bindings - 绑定参数映射，用于获取实体和条件数据
    
    entityClass - 实体类类型
    
    tableAlias - 表别名，如果为null则使用默认别名
    
    byId - 是否根据ID更新的标识
    
    entityKey - 实体数据在bindings中的键名
    
    whereKey - 条件数据在bindings中的键名
    
    columnPredicate - 实体列过滤谓词
    
    whereColumnPredicate - 条件列过滤谓词
    
    返回:
    
    构建好的更新语句对象
  - buildSelect
```
public static SelectStatement<?> buildSelect(Map<String,Object> bindings,
                                             EntitySelect entitySelect)
```
    构建SELECT语句对象
    
    参数:
    
    bindings - 参数绑定映射表，用于存储查询参数的键值对
    
    entitySelect - 实体选择对象，包含查询所需的表信息和条件配置
    
    返回:
    
    返回构建好的SelectStatement对象，用于执行数据库查询操作
  - buildSelect
```
public static SelectStatement<?> buildSelect(Map<String,Object> bindings,
                                             Class<?> entityClass,
                                             String tableAlias,
                                             boolean byId,
                                             String entityKey,
                                             String whereKey,
                                             String orderByKey,
                                             ColumnPredicate columnPredicate,
                                             boolean exceptLogicDeleted)
```
    构建一个 SelectStatement 对象，用于执行数据库查询操作。
    
    参数:
    
    bindings - 参数绑定映射，用于获取查询条件、排序等参数
    
    entityClass - 实体类，表示查询的目标表对应的实体类型
    
    tableAlias - 表别名，用于 SQL 查询中的表引用，默认为 "t"
    
    byId - 是否根据主键 ID 查询
    
    entityKey - 从 bindings 中获取实体对象的键名（优先作为整体实体条件）
    
    whereKey - 从 bindings 中获取 where 条件的键名（可为实体或 Criteria）
    
    orderByKey - 从 bindings 中获取排序条件的键名（可为字符串或 OrderBy 对象）
    
    columnPredicate - 列谓词过滤器，用于控制哪些字段参与条件构造
    
    exceptLogicDeleted - 是否排除逻辑删除的数据
    
    返回:
    
    构造完成的 SelectStatement 查询对象
  - buildMerge
```
public static MergeStatement<?> buildMerge(Map<String,Object> bindings,
                                           EntityMerge entityMerge)
```
    构建合并语句对象
    
    参数:
    
    bindings - 参数绑定映射表，用于存储SQL参数绑定
    
    entityMerge - 实体合并配置对象，包含合并操作的相关配置信息
    
    返回:
    
    返回构建好的合并语句对象
  - buildMerge
```
public static MergeStatement<?> buildMerge(Map<String,Object> bindings,
                                           Class<?> entityClass,
                                           String tableAlias,
                                           String entityKey,
                                           boolean updateWhenMatched,
                                           boolean insertWhenNotMatched,
                                           ColumnPredicate predicate)
```
    构建Merge语句对象
    
    参数:
    
    bindings - 参数绑定映射表，用于存储SQL参数值
    
    entityClass - 实体类类型，表示要操作的数据库表对应的实体类
    
    tableAlias - 表别名，用于在SQL语句中引用表
    
    entityKey - 实体键，用于标识实体的唯一性
    
    updateWhenMatched - 当匹配时是否执行更新操作的标志
    
    insertWhenNotMatched - 当不匹配时是否执行插入操作的标志
    
    predicate - 列谓词注解，用于定义列的过滤条件
    
    返回:
    
    返回构建好的Merge语句对象
  - buildMerge
```
public static MergeStatement<?> buildMerge(Map<String,Object> bindings,
                                           Class<?> entityClass,
                                           String tableAlias,
                                           String entityKey,
                                           boolean updateWhenMatched,
                                           boolean insertWhenNotMatched,
                                           ColumnPredicate columnPredicate)
```
    构建MergeStatement对象的工厂方法
    
    参数:
    
    bindings - 包含实体数据的绑定映射表
    
    entityClass - 实体类的Class对象
    
    tableAlias - 表别名，如果为null则使用默认别名
    
    entityKey - 实体在bindings中的键名
    
    updateWhenMatched - 当匹配时是否执行更新操作
    
    insertWhenNotMatched - 当不匹配时是否执行插入操作
    
    columnPredicate - 列谓词，用于过滤列操作
    
    返回:
    
    构建好的MergeStatement对象

类 EntityStatements

字段概要

构造器概要

方法概要

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

字段详细资料

DEFAULT_TABLE_ALIAS

构造器详细资料

EntityStatements

方法详细资料

getTableMeta

asTableAccessible

buildSqlUpdateFunction

buildSqlSelectFunction

buildSqlRawFunction

buildSqlInsert

buildSqlDelete

buildSqlUpdate

buildSqlSelectSet

buildSqlSelect

buildInsert

buildInsert

buildInsert

buildDelete

buildDelete

buildUpdate

buildUpdate

buildUpdate

buildSelect

buildSelect

buildMerge

buildMerge

buildMerge