Query (fastmybatis-core 1.10.8 API)

java.lang.Object
- com.gitee.fastmybatis.core.query.Query

所有已实现的接口:: Expressional, Pageable, Queryable, Sortable

public class Query
extends Object
implements Queryable

查询类

 查询姓名为张三，并且年龄为22岁的用户：
 Query query = new Query().eq("username","张三").eq("age",22);
 List users = mapper.list(query);

 查询年龄为10,20,30的用户：
 Query query = new Query().in("age",Arrays.asList(10,20,30));
 List users = mapper.list(query);

 查询注册日期大于2017-11-11的用户：
 Date regDate = ...
 Query query = new Query().gt("reg_date",regDate);
 List users = mapper.list(query);

 查询性别为男的，年龄大于等于20岁的用户，按年龄降序：
 Query query = new Query().eq("gender",1).ge("age",20).orderby("age",Sort.DESC);
 List users = mapper.list(query);

 分页查询：
 Query query = new Query().eq("age",10).page(1,10); // 第一页，每页10条数据
 List users = mapper.list(query);

 查询总记录数：
 Query query = new Query().eq("age",10).page(1,10); // 第一页，每页10条数据
 long total = mapper.getCount(query); // 该条件下总记录数

作者:: tanghc

构造器概要

构造器
构造器和说明

Query()

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

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addAll(List<Expression> expressions)`
`Query`	`addAnnotionExpression(Object searchEntity)` 添加注解查询条件
`Expressional`	`addExpression(Expression expression)` 添加表达式
`Query`	`addPaginationInfo(SchPageableParam searchEntity)` 添加分页信息
`Query`	`addParam(String name, Object value)` 添加额外参数
`Query`	`addSort(String sortname)` 添加ASC排序字段,
`Query`	`addSort(String sortname, Sort sort)` 添加字段排序
`Query`	`addSortInfo(SchSortableParam searchEntity)` 添加排序信息
`Query`	`allEq(LinkedHashMap<String,Object> map)` 使用key/value进行多个等于的比对,相当于多个eq的效果
`Query`	`argPlaceholder(String argPlaceholder)` 设置参数占位符，默认'?'
`static Query`	`build(Object searchEntity)` 构建查询条件.
`static Query`	`buildFromBeanByProperty(Object bean)` 将bean中的字段转换成条件,不会将字段名转换成下划线形式.
`Query`	`disableDistinct()`
`Query`	`disableForceQuery()` 关闭强力查询，逻辑删除字段生效
`Query`	`disableForceUpdate()`
`Query`	`enableDistinct()` 使用distinct，开启后，会在主键上加distinct。
`Query`	`enableForceQuery()` 开启强力查询，将无视逻辑删除字段
`Query`	`enableForceUpdate()` 开启强制更新，那么null字段也会更新进去
`Query`	`eq(String columnName, Object value)` 添加等于条件
`Query`	`ge(String columnName, Object value)` 大于等于,>=
`boolean`	`getDistinct()`
`boolean`	`getForceQuery()`
`boolean`	`getForceUpdate()`
`boolean`	`getIsQueryAll()` 是否查询全部
`boolean`	`getIsSetTotal()` 是否设置总记录数
`List<ExpressionJoinable>`	`getJoinExpressions()` 返回连接表达式列表
`int`	`getLimit()` 返回偏移量
`List<ExpressionListable>`	`getListExpressions()` 返回集合表达式列表
`String`	`getOrder()` 返回排序信息
`boolean`	`getOrderable()` 是否具备排序,是返回true
`Map<String,Object>`	`getParam()` 返回自定义参数，在xml中使用`#{参数名}`获取值
`List<ExpressionSqlable>`	`getSqlExpressions()` 返回自定义sql表达式列表
`int`	`getStart()` 返回其实位置
`int`	`getTotal()` 返回总记录数
`List<ExpressionValueable>`	`getValueExpressions()` 返回单值表达式
`Query`	`gt(String columnName, Object value)` 添加大于条件,>
`Query`	`ignoreLogicDeleteColumn()` 无视逻辑删除字段
`Query`	`in(String columnName, Collection<?> value)` 添加IN条件
`<T> Query`	`in(String columnName, Collection<T> value, ValueConvert<T> valueConvert)` 添加IN条件
`Query`	`in(String columnName, Object[] value)` 添加IN条件
`Query`	`isEmpty(String column)` 空字段条件，null或者空字符串
`Query`	`isNull(String column)` 字段是null的条件
`Query`	`join(String joinSql)` 添加关联条件
`Query`	`le(String columnName, Object value)` 小于等于,<=
`Query`	`like(String columnName, String value)` 添加两边模糊查询条件，两边模糊匹配，即name like '%value%'
`Query`	`likeLeft(String columnName, String value)` 添加左模糊查询条件，左边模糊匹配，即name like '%value'
`Query`	`likeRight(String columnName, String value)` 添加右模糊查询条件，右边模糊匹配，即name like 'value%'。
`Query`	`limit(int start, int offset)` 设置分页信息,针对不规则分页。
`Query`	`lt(String columnName, Object value)` 添加小于条件,<
`Query`	`notEmpty(String column)` 不为空字符串
`Query`	`notEq(String columnName, Object value)` 添加不等于条件
`Query`	`notIn(String columnName, Collection<?> value)` 添加not in条件
`<T> Query`	`notIn(String columnName, Collection<T> value, ValueConvert<T> valueConvert)` 添加not in条件
`Query`	`notIn(String columnName, Object[] value)` 添加not in条件
`Query`	`notNull(String column)` 字段不为null的条件
`Query`	`oneEqTwo()` 添加1=2条件
`Query`	`orderby(String sortname, Sort sort)` 字段排序
`Query`	`page(int pageIndex, int pageSize)` 设置分页信息
`Query`	`setQueryAll(boolean queryAll)` 查询全部
`void`	`setTotal(int total)`
`Query`	`sql(String sql)` 已过时。
`Query`	`sql(String sqlFormat, Object... args)` 添加自定义sql条件
`Query`	`sqlInjectRegex(String sqlInjectRegex)` 设置SQL注入正则表达式

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

- 构造器详细资料
  - Query
```
public Query()
```
- 方法详细资料
  - eq
```
public Query eq(String columnName,
                Object value)
```
    添加等于条件
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    返回:
    
    返回Query对象
  - notEq
```
public Query notEq(String columnName,
                   Object value)
```
    添加不等于条件
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    返回:
    
    返回Query对象
  - gt
```
public Query gt(String columnName,
                Object value)
```
    添加大于条件,>
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    返回:
    
    返回Query对象
  - ge
```
public Query ge(String columnName,
                Object value)
```
    大于等于,>=
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    返回:
    
    返回Query对象
  - lt
```
public Query lt(String columnName,
                Object value)
```
    添加小于条件,<
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    返回:
    
    返回Query对象
  - le
```
public Query le(String columnName,
                Object value)
```
    小于等于,<=
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    返回:
    
    返回Query对象
  - like
```
public Query like(String columnName,
                  String value)
```
    添加两边模糊查询条件，两边模糊匹配，即name like '%value%'
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值,不需要加%
    
    返回:
    
    返回Query对象
    
    另请参阅:
    
    左边模糊匹配, 右边模糊匹配
  - likeLeft
```
public Query likeLeft(String columnName,
                      String value)
```
    添加左模糊查询条件，左边模糊匹配，即name like '%value'
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值,不需要加%
    
    返回:
    
    返回Query对象
  - likeRight
```
public Query likeRight(String columnName,
                       String value)
```
    添加右模糊查询条件，右边模糊匹配，即name like 'value%'。mysql推荐用这种
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值,不需要加%
    
    返回:
    
    返回Query对象
  - in
```
public Query in(String columnName,
                Collection<?> value)
```
    添加IN条件
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    返回:
    
    返回Query对象
  - in
```
public <T> Query in(String columnName,
                    Collection<T> value,
                    ValueConvert<T> valueConvert)
```
    添加IN条件
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    valueConvert - 转换
    
    返回:
    
    返回Query对象
  - in
```
public Query in(String columnName,
                Object[] value)
```
    添加IN条件
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    返回:
    
    返回Query对象
  - notIn
```
public Query notIn(String columnName,
                   Collection<?> value)
```
    添加not in条件
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    返回:
    
    返回Query对象
  - notIn
```
public <T> Query notIn(String columnName,
                       Collection<T> value,
                       ValueConvert<T> valueConvert)
```
    添加not in条件
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    valueConvert - 转换器
    
    返回:
    
    返回Query对象
  - notIn
```
public Query notIn(String columnName,
                   Object[] value)
```
    添加not in条件
    
    参数:
    
    columnName - 数据库字段名
    
    value - 值
    
    返回:
    
    返回Query对象
  - sql
```
@Deprecated
public Query sql(String sql)
```
    已过时。
    
    添加自定义sql条件
    
    参数:
    
    sql - 自定义sql
    
    返回:
    
    返回Query对象
    
    另请参阅:
    
    sql(String, Object...)
  - sql
```
public Query sql(String sqlFormat,
                 Object... args)
```
    添加自定义sql条件
    
    参数:
    
    sqlFormat - SQL模板，参数值使用?代替，如：username = ? and nickname like '%?%'
    
    args - 参数
    
    返回:
    
    返回Query对象
  - notNull
```
public Query notNull(String column)
```
    字段不为null的条件
    
    参数:
    
    column - 数据库字段名
    
    返回:
    
    返回Query对象
  - isNull
```
public Query isNull(String column)
```
    字段是null的条件
    
    参数:
    
    column - 数据库字段名
    
    返回:
    
    返回Query对象
  - notEmpty
```
public Query notEmpty(String column)
```
    不为空字符串
    
    参数:
    
    column - 数据库字段名
    
    返回:
    
    返回Query对象
  - isEmpty
```
public Query isEmpty(String column)
```
    空字段条件，null或者空字符串
    
    参数:
    
    column - 数据库字段名
    
    返回:
    
    返回Query对象
  - oneEqTwo
```
public Query oneEqTwo()
```
    添加1=2条件
    
    返回:
    
    返回Query对象
  - join
```
public Query join(String joinSql)
```
    添加关联条件
    
    参数:
    
    joinSql - 连接sql语句，如：“left join user_info t2 on t.id=t2.user_id”
    
    返回:
    
    返回Query对象
  - allEq
```
public Query allEq(LinkedHashMap<String,Object> map)
```
    使用key/value进行多个等于的比对,相当于多个eq的效果
    
    参数:
    
    map - 键值对
    
    返回:
    
    返回Query对象
  - page
```
public Query page(int pageIndex,
                  int pageSize)
```
    设置分页信息
    
    参数:
    
    pageIndex - 当前第几页,从1开始
    
    pageSize - 每页结果集大小
    
    返回:
    
    返回Query对象
  - limit
```
public Query limit(int start,
                   int offset)
```
    设置分页信息,针对不规则分页。对应mysql分页语句：limit {start},{offset}
    
    参数:
    
    start - 记录起始位置
    
    offset - 偏移量
    
    返回:
    
    返回Query对象
  - getStart
```
public int getStart()
```
    从接口复制的说明: Pageable
    
    返回其实位置
    
    指定者:
    
    getStart 在接口中 Pageable
    
    返回:
    
    返回其实位置
  - getTotal
```
public int getTotal()
```
    从接口复制的说明: Pageable
    
    返回总记录数
    
    指定者:
    
    getTotal 在接口中 Pageable
    
    返回:
    
    返回总记录数
  - getIsSetTotal
```
public boolean getIsSetTotal()
```
    从接口复制的说明: Pageable
    
    是否设置总记录数
    
    指定者:
    
    getIsSetTotal 在接口中 Pageable
    
    返回:
    
    返回是否设置总记录数
  - setTotal
```
public void setTotal(int total)
```
  - getLimit
```
public int getLimit()
```
    从接口复制的说明: Pageable
    
    返回偏移量
    
    指定者:
    
    getLimit 在接口中 Pageable
    
    返回:
    
    返回偏移量
  - orderby
```
public Query orderby(String sortname,
                     Sort sort)
```
    字段排序
    
    参数:
    
    sortname - 数据库字段名
    
    sort - 排序类型
    
    返回:
    
    返回Query对象
  - addSort
```
public Query addSort(String sortname)
```
    添加ASC排序字段,
    
    参数:
    
    sortname - 数据库字段名
    
    返回:
    
    返回Query对象
  - addSort
```
public Query addSort(String sortname,
                     Sort sort)
```
    添加字段排序
    
    参数:
    
    sortname - 数据库字段名
    
    sort - 排序类型
    
    返回:
    
    返回Query对象
  - getOrderable
```
public boolean getOrderable()
```
    从接口复制的说明: Sortable
    
    是否具备排序,是返回true
    
    指定者:
    
    getOrderable 在接口中 Sortable
    
    返回:
    
    true，具备排序
  - getOrder
```
public String getOrder()
```
    从接口复制的说明: Sortable
    
    返回排序信息
    
    指定者:
    
    getOrder 在接口中 Sortable
    
    返回:
    
    返回排序信息,如:id ASC,name ASC,date desc. 没有排序则返回""
  - addAnnotionExpression
```
public Query addAnnotionExpression(Object searchEntity)
```
    添加注解查询条件
    
    参数:
    
    searchEntity - 查询实体
    
    返回:
    
    返回Query对象
  - addPaginationInfo
```
public Query addPaginationInfo(SchPageableParam searchEntity)
```
    添加分页信息
    
    参数:
    
    searchEntity - 查询实体
    
    返回:
    
    返回Query对象
  - addSortInfo
```
public Query addSortInfo(SchSortableParam searchEntity)
```
    添加排序信息
    
    参数:
    
    searchEntity - 查询实体
    
    返回:
    
    返回Query对象
  - build
```
public static Query build(Object searchEntity)
```
    构建查询条件.
    
    参数:
    
    searchEntity - 查询实体
    
    返回:
    
    返回Query对象
  - buildFromBeanByProperty
```
public static Query buildFromBeanByProperty(Object bean)
```
    将bean中的字段转换成条件,不会将字段名转换成下划线形式.
```
 
 User user = new User();
 user.setUserName("jim");
 Query query = Query.buildFromBeanByProperty(user);
 
 这样会组装成一个条件:where userName='jim'
 更多功能可查看开发文档.
 
```
    参数:
    
    bean - 查询实体
    
    返回:
    
    返回Query对象
  - addExpression
```
public Expressional addExpression(Expression expression)
```
    从接口复制的说明: Expressional
    
    添加表达式
    
    指定者:
    
    addExpression 在接口中 Expressional
    
    参数:
    
    expression - 表达式对象
    
    返回:
    
    返回Expressional对象
  - addAll
```
public void addAll(List<Expression> expressions)
```
  - addParam
```
public Query addParam(String name,
                      Object value)
```
    添加额外参数
    
    参数:
    
    name - 参数名
    
    value - 值
    
    返回:
    
    返回Query对象
  - getParam
```
public Map<String,Object> getParam()
```
    从接口复制的说明: Queryable
    
    返回自定义参数，在xml中使用#{参数名}获取值
    
    指定者:
    
    getParam 在接口中 Queryable
    
    返回:
    
    返回自定义参数
  - getIsQueryAll
```
public boolean getIsQueryAll()
```
    从接口复制的说明: Pageable
    
    是否查询全部
    
    指定者:
    
    getIsQueryAll 在接口中 Pageable
    
    返回:
    
    是否查询全部
  - setQueryAll
```
public Query setQueryAll(boolean queryAll)
```
    查询全部
    
    参数:
    
    queryAll - true，则查询全部
    
    返回:
    
    返回Query对象
  - getValueExpressions
```
public List<ExpressionValueable> getValueExpressions()
```
    从接口复制的说明: Expressional
    
    返回单值表达式
    
    指定者:
    
    getValueExpressions 在接口中 Expressional
    
    返回:
    
    返回单值表达式
  - getJoinExpressions
```
public List<ExpressionJoinable> getJoinExpressions()
```
    从接口复制的说明: Expressional
    
    返回连接表达式列表
    
    指定者:
    
    getJoinExpressions 在接口中 Expressional
    
    返回:
    
    返回连接表达式列表
  - getListExpressions
```
public List<ExpressionListable> getListExpressions()
```
    从接口复制的说明: Expressional
    
    返回集合表达式列表
    
    指定者:
    
    getListExpressions 在接口中 Expressional
    
    返回:
    
    返回集合表达式列表
  - getSqlExpressions
```
public List<ExpressionSqlable> getSqlExpressions()
```
    从接口复制的说明: Expressional
    
    返回自定义sql表达式列表
    
    指定者:
    
    getSqlExpressions 在接口中 Expressional
    
    返回:
    
    返回自定义sql表达式列表
  - getForceQuery
```
public boolean getForceQuery()
```
  - enableForceQuery
```
public Query enableForceQuery()
```
    开启强力查询，将无视逻辑删除字段
    
    返回:
    
    返回Query对象
    
    另请参阅:
    
    逻辑删除注解
  - ignoreLogicDeleteColumn
```
public Query ignoreLogicDeleteColumn()
```
    无视逻辑删除字段
    
    返回:
    
    返回Query对象
    
    另请参阅:
    
    逻辑删除注解
  - disableForceQuery
```
public Query disableForceQuery()
```
    关闭强力查询，逻辑删除字段生效
    
    返回:
    
    返回Query对象
    
    另请参阅:
    
    逻辑删除注解
  - enableDistinct
```
public Query enableDistinct()
```
    使用distinct，开启后，会在主键上加distinct。distinct(t.id)
    仅限于mysql
  - disableDistinct
```
public Query disableDistinct()
```
  - getDistinct
```
public boolean getDistinct()
```
  - enableForceUpdate
```
public Query enableForceUpdate()
```
    开启强制更新，那么null字段也会更新进去
    
    返回:
    
    返回query对象
  - disableForceUpdate
```
public Query disableForceUpdate()
```
  - getForceUpdate
```
public boolean getForceUpdate()
```
  - argPlaceholder
```
public Query argPlaceholder(String argPlaceholder)
```
    设置参数占位符，默认'?'
    
    参数:
    
    argPlaceholder - 占位符
    
    返回:
    
    返回Query对象
  - sqlInjectRegex
```
public Query sqlInjectRegex(String sqlInjectRegex)
```
    设置SQL注入正则表达式
    
    参数:
    
    sqlInjectRegex - 正则
    
    返回:
    
    返回Query对象

类 Query

构造器概要

方法概要

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

构造器详细资料

Query

方法详细资料

eq

notEq

gt

ge

lt

le

like

likeLeft

likeRight

in

in

in

notIn

notIn

notIn

sql

sql

notNull

isNull

notEmpty

isEmpty

oneEqTwo

join

allEq

page

limit

getStart

getTotal

getIsSetTotal

setTotal

getLimit

orderby

addSort

addSort

getOrderable

getOrder

addAnnotionExpression

addPaginationInfo

addSortInfo

build

buildFromBeanByProperty

addExpression

addAll

addParam

getParam

getIsQueryAll

setQueryAll

getValueExpressions

getJoinExpressions

getListExpressions

getSqlExpressions

getForceQuery

enableForceQuery

ignoreLogicDeleteColumn

disableForceQuery

enableDistinct

disableDistinct

getDistinct

enableForceUpdate

disableForceUpdate

getForceUpdate

argPlaceholder

sqlInjectRegex