cn.zhxu.bs.bean

注释类型 SearchBean

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface SearchBean

用于注解一个 SearchBean v3.0.0 后该注解可以缺省，缺省时根据 DbMapping 自动映射数据库表

作者:

Troy.Zhou @ 2017-03-20

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	autoMapTo 当某字段同时未指定 DbField.value() 与 DbField.mapTo() 时，该属性指定它自动映射到哪张表 只有在 tables() 指定了多张表时起作用 当多表映射中，如果该属性为空，则表示未被 @DbField 注解的字段不需要映射
String	dataSource 指定数据源
boolean	distinct 是否 distinct 结果
DbField[]	fields 声明额外的条件字段，可根据字段参数动态生成 where 条件，用法： \@SearchBean(fields = { \@DbField(name = "name"), \@DbField(name = "age") // 这里的 name 是必填的 }) // 或者： \@SearchBean(fields = @DbField(name = "name")) 此处 DbField.cluster() 如果不显式指定，将自动推断为 Cluster.FALSE
String	groupBy 分组字段，例如 u.id,r.name
String	having 分组过滤条件，有 groupBy() 时才会生效
String[]	ignoreFields
InheritType	inheritType 继承类型
String	orderBy
SortType	sortType 排序约束类型： 为 SortType.ALLOW_PARAM 时，表示：允许使用 检索参数 重新指定排序字段， 为 SortType.ONLY_ENTITY 时，表示：只可以 使用本注解的 orderBy() 属性指定排序字段，并会忽略 检索参数中的排序信息 为 SortType.DEFAULT 时，表示：根据检索器的实例级配置 DefaultDbMapping.getDefaultSortType() 来决定 是否允许使用 检索参数 重新指定排序字段
String	tables 参与检索的数据库表名，例如: users u, user_role ur, roles r v3.0.0 后可空，为空时以类名映射表名
int	timeout
String	where Where 条件，例如： u.id = ur.user_id and ur.role_id = r.id

元素详细资料

dataSource

public abstract String dataSource

指定数据源

返回:

数据源名称（name of DataSource）

从以下版本开始:

v3.0.0

另请参阅:

DefaultSqlExecutor.setDataSource(String name, DataSource)

默认值:

""

tables

public abstract String tables

参与检索的数据库表名，例如: users u, user_role ur, roles r v3.0.0 后可空，为空时以类名映射表名

返回:

tables

默认值:

""

where

public abstract String where

Where 条件，例如： u.id = ur.user_id and ur.role_id = r.id

返回:

where condition

从以下版本开始:

v3.8.0

默认值:

""

fields

public abstract DbField[] fields

声明额外的条件字段，可根据字段参数动态生成 where 条件，用法： \@SearchBean(fields = { \@DbField(name = "name"), \@DbField(name = "age") // 这里的 name 是必填的 }) // 或者： \@SearchBean(fields = @DbField(name = "name")) 此处 DbField.cluster() 如果不显式指定，将自动推断为 Cluster.FALSE

返回:

额外的条件字段

从以下版本开始:

v4.1.0

默认值:

{}

groupBy

public abstract String groupBy

分组字段，例如 u.id,r.name

返回:

group information

默认值:

""

having

public abstract String having

分组过滤条件，有 groupBy() 时才会生效

返回:

having clause

从以下版本开始:

v3.8.0

默认值:

""

distinct

public abstract boolean distinct

是否 distinct 结果

返回:

distinct

默认值:

false

autoMapTo

public abstract String autoMapTo

当某字段同时未指定 DbField.value() 与 DbField.mapTo() 时，该属性指定它自动映射到哪张表

只有在 tables() 指定了多张表时起作用

当多表映射中，如果该属性为空，则表示未被 @DbField 注解的字段不需要映射

返回:

自动映射的表名 或 别名

从以下版本开始:

v3.0.0

默认值:

""

inheritType

public abstract InheritType inheritType

继承类型

返回:

InheritType

从以下版本开始:

v3.2.0

默认值:

cn.zhxu.bs.bean.InheritType.DEFAULT

ignoreFields

public abstract String[] ignoreFields

返回:

需要忽略的属性名

从以下版本开始:

v3.4.0

默认值:

{}

orderBy

public abstract String orderBy

返回:

默认排序字段信息

从以下版本开始:

v3.6.0

默认值:

""

sortType

public abstract SortType sortType

排序约束类型： 为 SortType.ALLOW_PARAM 时，表示：允许使用 检索参数 重新指定排序字段， 为 SortType.ONLY_ENTITY 时，表示：只可以 使用本注解的 orderBy() 属性指定排序字段，并会忽略 检索参数中的排序信息 为 SortType.DEFAULT 时，表示：根据检索器的实例级配置 DefaultDbMapping.getDefaultSortType() 来决定 是否允许使用 检索参数 重新指定排序字段

返回:

排序约束类型

从以下版本开始:

v3.6.0

默认值:

cn.zhxu.bs.bean.SortType.DEFAULT

timeout

public abstract int timeout

返回:

单条 SQL 执行超时时间，单位：秒，0 表示永远不超时

默认值:

0