ColumnReference (Dynamic-SQL2 0.3.0 API)

java.lang.Object
- com.dynamic.sql.core.AbstractColumnReference
- - com.dynamic.sql.core.ColumnReference

public class ColumnReference
extends AbstractColumnReference

字段概要
- 从类继承的字段 com.dynamic.sql.core.AbstractColumnReference
  selectSpecification

构造器概要

构造器
构造器和说明

ColumnReference(SelectSpecification selectSpecification)

构造器
构造器和说明
`ColumnReference(SelectSpecification selectSpecification)`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`AbstractColumnReference`	`allColumn()` 选择所有列。
`AbstractColumnReference`	`allColumn(Class<?> tableClass)` 选择特定表的所有列。
`AbstractColumnReference`	`allColumn(String tableAlias)` 选择指定表别名的所有列。
`ColumnReference`	`column(AbstractColumFunction iColumFunction)` 添加一个函数列到查询中。
`AbstractColumnReference`	`column(AbstractColumFunction iColumFunction, String columnAlias)` 添加一个带别名的函数列到查询中。
`<T,F> ColumnReference`	`column(FieldFn<T,F> fn, String columnAlias)` 添加一个列到查询中，并设置列别名。
`<T,F> ColumnReference`	`column(Fn<T,F> fn)` 添加一个列到查询中，使用方法引用指定字段。
`AbstractColumnReference`	`column(NumberColumn numberColumn)` 添加一个数字列到查询中。
`AbstractColumnReference`	`column(SelectDsl nestedSelect, String columnAlias)` 添加一个嵌套查询列到当前查询中。
`<T,F> ColumnReference`	`column(String tableAlias, FieldFn<T,F> fn)` 添加一个带有表别名的列到查询中。
`<T,F> ColumnReference`	`column(String tableAlias, FieldFn<T,F> fn, String columnAlias)` 添加一个带有表别名和列别名的列到查询中。
`AbstractColumnReference`	`column(String tableAlias, String columnName)` 添加一个自定义列到查询中。
`AbstractColumnReference`	`column(String tableAlias, String columnName, String columnAlias)` 添加一个带有别名的自定义列到查询中。
`AbstractColumnReference`	`column(WindowsFunction windowsFunction, Consumer<Over> over, String columnAlias)` 添加一个窗口函数列到查询中。
`AbstractColumnReference`	`columnReference(AbstractColumnReference columnReference)` 已过时。
`AbstractColumnReference`	`distinct()` 添加去重关键字（DISTINCT）到查询中。
`<T> TableRelation<T>`	`from(Class<T> tableClass)` 设置查询的主表。
`<T> TableRelation<T>`	`from(Class<T> tableClass, String alias)` 设置带有别名的主表。
`TableRelation<?>`	`from(CteTable cteTable)` 设置公共表表达式（CTE）为主表。
`TableRelation<?>`	`from(SelectDsl nestedSelect, String selectAlias)` 设置嵌套查询作为主表。
`<T> TableRelation<T>`	`from(Supplier<TableFunction> tableFunction, String tableAlias)` 设置表函数作为主表。
`TableRelation<?>`	`fromUnion(SelectDsl[] selectDsl, String selectAlias)` 构建 UNION 查询的表关系。
`TableRelation<?>`	`fromUnionAll(SelectDsl[] selectDsl, String selectAlias)` 构建 UNION ALL 查询的表关系。
`<T,F> AbstractColumnReference`	`ignoreColumn(Fn<T,F> fn)` 显式忽略一个列，使其不参与查询结果。
`AbstractColumnReference`	`nestedColumn(KeyMapping<?,?> keyMapping, Function<AbstractColumnReference,AbstractColumnReference> valueMapper, String targetProperty)` 执行“直接嵌套集合或对象”的列引用构建逻辑。
`static AbstractColumnReference`	`withColumns()` 构建一个查询列的引用集合，用于定义查询中的多个列。

从类继承的方法 com.dynamic.sql.core.AbstractColumnReference
allColumn, allColumn, allColumn, collectionColumn, collectionColumn, column, column, column, column, column, column, column, column, column, column, column, column, column, distinct, getSelectSpecification, ignoreColumn, includeColumns, includeColumns, nestedColumn

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

- 构造器详细资料
  - ColumnReference
```
public ColumnReference(SelectSpecification selectSpecification)
```
- 方法详细资料
  - distinct
```
public AbstractColumnReference distinct()
```
    从类复制的说明: AbstractColumnReference
    
    添加去重关键字（DISTINCT）到查询中。
    该方法会将 `DISTINCT` 关键字应用到当前查询的列选择中，确保返回结果中不包含重复记录。
    
    指定者:
    
    distinct 在类中 AbstractColumnReference
    
    返回:
    
    当前列引用的实例，用于链式调用
  - withColumns
```
public static AbstractColumnReference withColumns()
```
    构建一个查询列的引用集合，用于定义查询中的多个列。
    此方法创建并返回一个 `AbstractColumnReference` 实例，允许通过链式调用添加列或嵌套的列引用。
    示例：
```
 AbstractColumnReference columnReference = ColumnReference.withColumns()
         .column(Product::getProductId)
         .column(Product::getProductName)
         .columnReference(nestedColumnReference());
 
```
    返回:
    
    一个用于构建列集合的 AbstractColumnReference 对象
  - column
```
public <T,F> ColumnReference column(Fn<T,F> fn)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个列到查询中，使用方法引用指定字段。
    通过方法引用（`Fn`）选择实体类中的特定字段，添加到查询列列表中。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    类型参数:
    
    T - 表对应的实体类类型
    
    F - 字段的类型
    
    参数:
    
    fn - 映射函数，用于引用实体类中的字段
    
    返回:
    
    当前列引用的实例，用于链式调用
  - ignoreColumn
```
public <T,F> AbstractColumnReference ignoreColumn(Fn<T,F> fn)
```
    从类复制的说明: AbstractColumnReference
    
    显式忽略一个列，使其不参与查询结果。
    常用于在已经选择了多个列的情况下，排除掉其中某些不需要的列。
    
    指定者:
    
    ignoreColumn 在类中 AbstractColumnReference
    
    类型参数:
    
    T - 表对应的实体类类型
    
    F - 字段的类型
    
    参数:
    
    fn - 字段引用函数，通常为实体类的 getter 方法引用
    
    返回:
    
    当前列引用实例，用于链式调用
  - column
```
public <T,F> ColumnReference column(String tableAlias,
                                    FieldFn<T,F> fn)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个带有表别名的列到查询中。
    通过指定表别名和方法引用选择字段，适用于多表查询场景。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    类型参数:
    
    T - 表对应的实体类类型
    
    F - 字段的类型
    
    参数:
    
    tableAlias - 表的别名，用于区分同名字段
    
    fn - 映射函数，用于引用实体类中的字段
    
    返回:
    
    当前列引用的实例，用于链式调用
  - column
```
public <T,F> ColumnReference column(FieldFn<T,F> fn,
                                    String columnAlias)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个列到查询中，并设置列别名。
    通过方法引用选择字段，并为列指定别名，便于结果映射或查询结果识别。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    类型参数:
    
    T - 表对应的实体类类型
    
    F - 字段的类型
    
    参数:
    
    fn - 映射函数，用于引用实体类中的字段
    
    columnAlias - 列的别名
    
    返回:
    
    当前列引用的实例，用于链式调用
  - column
```
public <T,F> ColumnReference column(String tableAlias,
                                    FieldFn<T,F> fn,
                                    String columnAlias)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个带有表别名和列别名的列到查询中。
    适用于多表查询场景，通过表别名和列别名明确指定字段。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    类型参数:
    
    T - 表对应的实体类类型
    
    F - 字段的类型
    
    参数:
    
    tableAlias - 表的别名
    
    fn - 映射函数，用于引用实体类中的字段
    
    columnAlias - 列的别名
    
    返回:
    
    当前列引用的实例，用于链式调用
  - column
```
public AbstractColumnReference column(String tableAlias,
                                      String columnName)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个自定义列到查询中。
    通过指定表别名和列名，适合手动定义列或非实体字段。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    参数:
    
    tableAlias - 表的别名
    
    columnName - 列名
    
    返回:
    
    当前列引用的实例，用于链式调用
  - column
```
public AbstractColumnReference column(String tableAlias,
                                      String columnName,
                                      String columnAlias)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个带有别名的自定义列到查询中。
    通过表别名、列名和列别名定义自定义字段。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    参数:
    
    tableAlias - 表的别名
    
    columnName - 列名
    
    columnAlias - 列的别名
    
    返回:
    
    当前列引用的实例，用于链式调用
  - column
```
public ColumnReference column(AbstractColumFunction iColumFunction)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个函数列到查询中。
    通过 AbstractColumFunction 定义聚合函数或标量函数（如 `SUM`、`ROUND`）。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    参数:
    
    iColumFunction - 函数列的定义
    
    返回:
    
    当前列引用的实例，用于链式调用
  - column
```
public AbstractColumnReference column(AbstractColumFunction iColumFunction,
                                      String columnAlias)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个带别名的函数列到查询中。
    为函数列指定别名，便于结果映射。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    参数:
    
    iColumFunction - 函数列的定义
    
    columnAlias - 列的别名
    
    返回:
    
    当前列引用的实例，用于链式调用
  - column
```
public AbstractColumnReference column(NumberColumn numberColumn)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个数字列到查询中。
    通过 NumberColumn 定义数字相关的列操作。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    参数:
    
    numberColumn - 数字列对象
    
    返回:
    
    当前列引用的实例，用于链式调用
  - column
```
public AbstractColumnReference column(WindowsFunction windowsFunction,
                                      Consumer<Over> over,
                                      String columnAlias)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个窗口函数列到查询中。
    通过 WindowsFunction 和 Over 定义窗口函数（如 `RANK`、`LAG`），并指定窗口定义。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    参数:
    
    windowsFunction - 窗口函数实例
    
    over - 窗口定义的消费者，用于配置排序或分区
    
    columnAlias - 列的别名
    
    返回:
    
    当前列引用的实例，用于链式调用
  - column
```
public AbstractColumnReference column(SelectDsl nestedSelect,
                                      String columnAlias)
```
    从类复制的说明: AbstractColumnReference
    
    添加一个嵌套查询列到当前查询中。
    通过嵌套查询定义一个子查询列，适合复杂查询场景。
    
    指定者:
    
    column 在类中 AbstractColumnReference
    
    参数:
    
    nestedSelect - 嵌套查询的定义，接受一个消费者来构建子查询
    
    columnAlias - 列的别名
    
    返回:
    
    当前列引用的实例，用于链式调用
  - nestedColumn
```
public AbstractColumnReference nestedColumn(KeyMapping<?,?> keyMapping,
                                            Function<AbstractColumnReference,AbstractColumnReference> valueMapper,
                                            String targetProperty)
```
    从类复制的说明: AbstractColumnReference
    执行“直接嵌套集合或对象”的列引用构建逻辑。
    该方法用于构建复杂对象结构的字段映射，例如：
    - 实体中包含嵌套对象（如 User → Address）
    - 实体中包含集合字段（如 User → List<Order>）
    方法会根据 keyMapping 确定父子对象的关联关系，通过 valueMapper 对嵌套列引用进行加工，最终将结果绑定到 targetProperty 指定的实体字段上。
    指定者:
    
    nestedColumn 在类中 AbstractColumnReference
    
    参数:
    
    keyMapping - 主键/外键映射关系，用于确定嵌套对象或集合的关联方式
    
    valueMapper - 对嵌套列引用进行加工的函数，可用于构建集合、对象或进一步嵌套
    
    targetProperty - 目标属性名称（实体类字段名），用于将嵌套结果写入对应对象或集合
    
    返回:
    
    构建完成的嵌套列引用对象
  - columnReference
```
@Deprecated
public AbstractColumnReference columnReference(AbstractColumnReference columnReference)
```
    已过时。
    
    从类复制的说明: AbstractColumnReference
    
    添加另一个列引用到当前查询中。
    注意：该方法已过时，将在未来版本中移除，建议使用 AbstractColumnReference.includeColumns(AbstractColumnReference) 替代。
    
    指定者:
    
    columnReference 在类中 AbstractColumnReference
    
    参数:
    
    columnReference - 另一个列引用实例
    
    返回:
    
    当前列引用的实例，用于链式调用
  - allColumn
```
public AbstractColumnReference allColumn()
```
    从类复制的说明: AbstractColumnReference
    
    选择所有列。
    添加当前查询的所有列（无条件选择），适用于选择表中的全部字段。
    
    指定者:
    
    allColumn 在类中 AbstractColumnReference
    
    返回:
    
    当前列引用的实例，用于链式调用
  - allColumn
```
public AbstractColumnReference allColumn(Class<?> tableClass)
```
    从类复制的说明: AbstractColumnReference
    
    选择特定表的所有列。
    根据指定的实体类选择表中的所有列。
    
    指定者:
    
    allColumn 在类中 AbstractColumnReference
    
    参数:
    
    tableClass - 表对应的实体类
    
    返回:
    
    当前列引用的实例，用于链式调用
  - allColumn
```
public AbstractColumnReference allColumn(String tableAlias)
```
    从类复制的说明: AbstractColumnReference
    
    选择指定表别名的所有列。
    根据表别名选择对应的所有列，适用于多表查询。
    
    指定者:
    
    allColumn 在类中 AbstractColumnReference
    
    参数:
    
    tableAlias - 表别名
    
    返回:
    
    当前列引用的实例，用于链式调用
  - from
```
public <T> TableRelation<T> from(Class<T> tableClass)
```
    从类复制的说明: AbstractColumnReference
    
    设置查询的主表。
    指定实体类作为主表，初始化查询的数据源。
    
    指定者:
    
    from 在类中 AbstractColumnReference
    
    类型参数:
    
    T - 表对应的实体类类型
    
    参数:
    
    tableClass - 表对应的实体类
    
    返回:
    
    TableRelation 对象，用于定义表关系
  - from
```
public <T> TableRelation<T> from(Class<T> tableClass,
                                 String alias)
```
    从类复制的说明: AbstractColumnReference
    
    设置带有别名的主表。
    指定实体类和表别名作为主表，适用于多表或别名查询。
    
    指定者:
    
    from 在类中 AbstractColumnReference
    
    类型参数:
    
    T - 表对应的实体类类型
    
    参数:
    
    tableClass - 表对应的实体类
    
    alias - 表别名
    
    返回:
    
    TableRelation 对象，用于定义表关系
  - from
```
public <T> TableRelation<T> from(Supplier<TableFunction> tableFunction,
                                 String tableAlias)
```
    从类复制的说明: AbstractColumnReference
    
    设置表函数作为主表。
    通过 TableFunction 和别名定义动态表，适合复杂查询。
    
    指定者:
    
    from 在类中 AbstractColumnReference
    
    类型参数:
    
    T - 表对应的实体类类型
    
    参数:
    
    tableFunction - 表函数的供应商
    
    tableAlias - 表别名
    
    返回:
    
    TableRelation 对象，用于定义表关系
  - from
```
public TableRelation<?> from(CteTable cteTable)
```
    从类复制的说明: AbstractColumnReference
    
    设置公共表表达式（CTE）为主表。
    使用 CteTable 定义 CTE 作为查询的数据源。
    
    指定者:
    
    from 在类中 AbstractColumnReference
    
    参数:
    
    cteTable - 公共表表达式对象
    
    返回:
    
    TableRelation 对象，用于定义表关系
  - from
```
public TableRelation<?> from(SelectDsl nestedSelect,
                             String selectAlias)
```
    从类复制的说明: AbstractColumnReference
    
    设置嵌套查询作为主表。
    通过嵌套查询定义子查询作为主表，适合复杂数据源。
    
    指定者:
    
    from 在类中 AbstractColumnReference
    
    参数:
    
    nestedSelect - 嵌套查询的定义，接受一个消费者来构建子查询
    
    selectAlias - 嵌套查询的别名
    
    返回:
    
    TableRelation 对象，用于定义表关系
  - fromUnion
```
public TableRelation<?> fromUnion(SelectDsl[] selectDsl,
                                  String selectAlias)
```
    从类复制的说明: AbstractColumnReference
    构建 UNION 查询的表关系。
    该方法用于将多个子查询（SELECT DSL）通过 UNION 组合成一个虚拟表，并在 FROM 子句中以指定别名引用。例如：
```
     FROM (
         SELECT ... FROM ...
         UNION
         SELECT ... FROM ...
         UNION
         SELECT ... FROM ...
     ) AS t
 
```
    可能的使用场景：
    - 将多个条件不同的查询合并为一个结果集
    - 构建动态 UNION 查询
    - 在 FROM 中使用虚拟表继续进行过滤、排序等操作
    指定者:
    
    fromUnion 在类中 AbstractColumnReference
    
    参数:
    
    selectDsl - 多个子查询的 DSL 数组，每个元素代表一个 SELECT 语句
    
    selectAlias - UNION 结果集在 FROM 子句中的别名
    
    返回:
    
    TableRelation 对象，用于定义表关系
  - fromUnionAll
```
public TableRelation<?> fromUnionAll(SelectDsl[] selectDsl,
                                     String selectAlias)
```
    从类复制的说明: AbstractColumnReference
    构建 UNION ALL 查询的表关系。
    该方法用于将多个子查询（SELECT DSL）通过 UNION ALL 组合成一个虚拟表，并在 FROM 子句中以指定别名引用。例如：
```
     FROM (
         SELECT ... FROM ...
         UNION ALL
         SELECT ... FROM ...
         UNION ALL
         SELECT ... FROM ...
     ) AS t
 
```
    可能的使用场景：
    - 将多个条件不同的查询合并为一个结果集
    - 构建动态 UNION ALL 查询
    - 在 FROM 中使用虚拟表继续进行过滤、排序等操作
    指定者:
    
    fromUnionAll 在类中 AbstractColumnReference
    
    参数:
    
    selectDsl - 多个子查询的 DSL 数组，每个元素代表一个 SELECT 语句
    
    selectAlias - UNION ALL 结果集在 FROM 子句中的别名
    
    返回:
    
    TableRelation 对象，用于定义表关系

类 ColumnReference

字段概要

从类继承的字段 com.dynamic.sql.core.AbstractColumnReference

构造器概要

方法概要

从类继承的方法 com.dynamic.sql.core.AbstractColumnReference

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

构造器详细资料

ColumnReference

方法详细资料

distinct

withColumns

column

ignoreColumn

column

column

column

column

column

column

column

column

column

column

nestedColumn

columnReference

allColumn

allColumn

allColumn

from

from

from

from

from

fromUnion

fromUnionAll