com.mybatisflex.core

接口 BaseMapper<T>

类型参数:

T - 实体类类型

public interface BaseMapper<T>

通用 Mapper 接口。

作者:

开源海哥, 庄佳彬, 闵柳华, 王帅, yangs, lhzsdnu, 王超

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_BATCH_SIZE 默认批量处理切片数量。

方法概要

限定符和类型	方法和说明
default int	delete(T entity) 根据实体主键来删除数据。
int	deleteBatchByIds(Collection<? extends Serializable> ids) 根据多个主键批量删除数据。
default int	deleteBatchByIds(List<? extends Serializable> ids, int size) 根据多个主键批量删除数据。
default int	deleteByCondition(QueryCondition whereConditions) 根据查询条件来删除数据。
int	deleteById(Serializable id) 根据主键删除数据。
default int	deleteByMap(Map<String,Object> whereConditions) 根据 Map 构建的条件来删除数据。
int	deleteByQuery(QueryWrapper queryWrapper) 根据查询条件来删除数据。
default int	insert(T entity) 插入实体类数据，不忽略 null 值。
int	insert(T entity, boolean ignoreNulls) 插入实体类数据。
int	insertBatch(List<T> entities) 批量插入实体类数据，只会根据第一条数据来构建插入的字段内容。
default int	insertBatch(List<T> entities, int size) 批量插入实体类数据，按 size 切分。
default int	insertOrUpdate(T entity) 插入或者更新，若主键有值，则更新，若没有主键值，则插入，插入或者更新都不会忽略 null 值。
default int	insertOrUpdate(T entity, boolean ignoreNulls) 插入或者更新，若主键有值，则更新，若没有主键值，则插入。
default int	insertOrUpdateSelective(T entity) 插入或者更新，若主键有值，则更新，若没有主键值，则插入，插入或者更新都会忽略 null 值。
default int	insertSelective(T entity) 插入实体类数据，但是忽略 null 的数据，只对有值的内容进行插入。
default int	insertSelectiveWithPk(T entity) 插入带有主键的实体类，忽略 null 值。
default int	insertWithPk(T entity) 插入带有主键的实体类，不忽略 null 值。
int	insertWithPk(T entity, boolean ignoreNulls) 带有主键的插入，此时实体类不会经过主键生成器生成主键。
default Page<T>	paginate(Number pageNumber, Number pageSize, Number totalRow, QueryCondition whereConditions) 分页查询。
default Page<T>	paginate(Number pageNumber, Number pageSize, Number totalRow, QueryWrapper queryWrapper) 分页查询。
default Page<T>	paginate(Number pageNumber, Number pageSize, QueryCondition whereConditions) 分页查询。
default Page<T>	paginate(Number pageNumber, Number pageSize, QueryWrapper queryWrapper) 分页查询。
default Page<T>	paginate(Page<T> page, QueryWrapper queryWrapper) 分页查询。
default Page<T>	paginate(Page<T> page, QueryWrapper queryWrapper, Consumer<FieldQueryBuilder<T>>... consumers) 分页查询。
default <R> Page<R>	paginateAs(Number pageNumber, Number pageSize, Number totalRow, QueryWrapper queryWrapper, Class<R> asType) 分页查询。
default <R> Page<R>	paginateAs(Number pageNumber, Number pageSize, QueryWrapper queryWrapper, Class<R> asType) 分页查询。
default <R> Page<R>	paginateAs(Page<R> page, QueryWrapper queryWrapper, Class<R> asType) 分页查询。
default <R> Page<R>	paginateAs(Page<R> page, QueryWrapper queryWrapper, Class<R> asType, Consumer<FieldQueryBuilder<R>>... consumers) 分页查询。
default Page<T>	paginateWithRelations(Number pageNumber, Number pageSize, Number totalRow, QueryCondition whereConditions) 分页查询，及其 Relation 字段内容。
default Page<T>	paginateWithRelations(Number pageNumber, Number pageSize, Number totalRow, QueryWrapper queryWrapper) 分页查询，及其 Relation 字段内容。
default Page<T>	paginateWithRelations(Number pageNumber, Number pageSize, QueryCondition whereConditions) 分页查询，及其 Relation 字段内容。
default Page<T>	paginateWithRelations(Number pageNumber, Number pageSize, QueryWrapper queryWrapper) 分页查询，及其 Relation 字段内容。
default Page<T>	paginateWithRelations(Page<T> page, QueryWrapper queryWrapper) 分页查询，及其 Relation 字段内容。
default Page<T>	paginateWithRelations(Page<T> page, QueryWrapper queryWrapper, Consumer<FieldQueryBuilder<T>>... consumers) 分页查询，及其 Relation 字段内容。
default <R> Page<R>	paginateWithRelationsAs(Number pageNumber, Number pageSize, Number totalRow, QueryWrapper queryWrapper, Class<R> asType) 分页查询，及其 Relation 字段内容。
default <R> Page<R>	paginateWithRelationsAs(Number pageNumber, Number pageSize, QueryWrapper queryWrapper, Class<R> asType) 分页查询，及其 Relation 字段内容。
default <R> Page<R>	paginateWithRelationsAs(Page<R> page, QueryWrapper queryWrapper, Class<R> asType) 分页查询，及其 Relation 字段内容。
default <R> Page<R>	paginateWithRelationsAs(Page<R> page, QueryWrapper queryWrapper, Class<R> asType, Consumer<FieldQueryBuilder<R>>... consumers) 分页查询，及其 Relation 字段内容。
default List<T>	selectAll() 查询全部数据。
default List<T>	selectAllWithRelations() 查询全部数据，及其 Relation 字段内容。
default long	selectCountByCondition(QueryCondition whereConditions) 根据条件查询数据总量。
default long	selectCountByQuery(QueryWrapper queryWrapper) 查询数据量。
org.apache.ibatis.cursor.Cursor<T>	selectCursorByQuery(QueryWrapper queryWrapper) 根据查询条件查询游标数据，该方法必须在事务中才能正常使用，非事务下无法获取数据。
default List<T>	selectListByCondition(QueryCondition whereConditions) 根据查询条件查询多条数据。
default List<T>	selectListByCondition(QueryCondition whereConditions, Long count) 根据查询条件查询多条数据。
List<T>	selectListByIds(Collection<? extends Serializable> ids) 根据多个主键来查询多条数据。
default List<T>	selectListByMap(Map<String,Object> whereConditions) 根据 Map 来构建查询条件，查询多条数据。
default List<T>	selectListByMap(Map<String,Object> whereConditions, Long count) 根据 Map 来构建查询条件，查询多条数据。
List<T>	selectListByQuery(QueryWrapper queryWrapper) 根据查询条件查询数据列表。
default List<T>	selectListByQuery(QueryWrapper queryWrapper, Consumer<FieldQueryBuilder<T>>... consumers) 根据查询条件查询数据列表。
default <R> List<R>	selectListByQueryAs(QueryWrapper queryWrapper, Class<R> asType) 根据查询条件查询数据列表，要求返回的数据为 asType。
default <R> List<R>	selectListByQueryAs(QueryWrapper queryWrapper, Class<R> asType, Consumer<FieldQueryBuilder<R>>... consumers) 根据查询条件查询数据列表，要求返回的数据为 asType 类型。
default List<T>	selectListWithRelationsByQuery(QueryWrapper queryWrapper) 查询实体类及其 Relation 注解字段。
default <R> List<R>	selectListWithRelationsByQueryAs(QueryWrapper queryWrapper, Class<R> asType) 查询实体类及其 Relation 注解字段。
default <R> List<R>	selectListWithRelationsByQueryAs(QueryWrapper queryWrapper, Class<R> asType, Consumer<FieldQueryBuilder<R>>... consumers) 查询实体类及其 Relation 注解字段。
default Object	selectObjectByQuery(QueryWrapper queryWrapper) 查询第一列返回的数据，QueryWrapper 执行的结果应该只有 1 列，例如： QueryWrapper.create().select(ACCOUNT.id).where(...);
default <R> R	selectObjectByQueryAs(QueryWrapper queryWrapper, Class<R> asType) 查询第一列返回的数据，QueryWrapper 执行的结果应该只有 1 列，例如： QueryWrapper.create().select(ACCOUNT.id).where(...);
List<Object>	selectObjectListByQuery(QueryWrapper queryWrapper) 查询第一列返回的数据集合，QueryWrapper 执行的结果应该只有 1 列，例如： QueryWrapper.create().select(ACCOUNT.id).where(...);
default <R> List<R>	selectObjectListByQueryAs(QueryWrapper queryWrapper, Class<R> asType) 查询第一列返回的数据集合，QueryWrapper 执行的结果应该只有 1 列，例如： QueryWrapper.create().select(ACCOUNT.id).where(...);
default T	selectOneByCondition(QueryCondition whereConditions) 根据查询条件查询数据。
default T	selectOneByEntityId(T entity) 根据实体主键查询数据。
T	selectOneById(Serializable id) 根据主键查询数据。
default T	selectOneByMap(Map<String,Object> whereConditions) 根据 Map 构建的条件来查询数据。
default T	selectOneByQuery(QueryWrapper queryWrapper) 根据查询条件来查询 1 条数据。
default <R> R	selectOneByQueryAs(QueryWrapper queryWrapper, Class<R> asType) 根据查询条件来查询 1 条数据。
default T	selectOneWithRelationsByCondition(QueryCondition whereConditions) 根据查询条件查询 1 条数据。
default T	selectOneWithRelationsById(Serializable id) 根据主表主键来查询 1 条数据。
default <R> R	selectOneWithRelationsByIdAs(Serializable id, Class<R> asType) 根据主表主键来查询 1 条数据。
default T	selectOneWithRelationsByMap(Map<String,Object> whereConditions) 根据 Map 构建的条件来查询 1 条数据。
default T	selectOneWithRelationsByQuery(QueryWrapper queryWrapper) 根据查询条件来查询 1 条数据。
default <R> R	selectOneWithRelationsByQueryAs(QueryWrapper queryWrapper, Class<R> asType) 根据查询条件来查询 1 条数据。
List<Row>	selectRowsByQuery(QueryWrapper queryWrapper) 根据查询条件查询 Row 数据。
default int	update(T entity) 根据主键来更新数据，若实体类属性数据为 null，该属性不会更新到数据库。
int	update(T entity, boolean ignoreNulls) 根据主键来更新数据到数据库。
default int	updateByCondition(T entity, boolean ignoreNulls, QueryCondition whereConditions) 根据查询条件来更新数据。
default int	updateByCondition(T entity, QueryCondition whereConditions) 根据查询条件来更新数据。
default int	updateByMap(T entity, boolean ignoreNulls, Map<String,Object> whereConditions) 根据 Map 构建的条件来更新数据。
default int	updateByMap(T entity, Map<String,Object> whereConditions) 根据 Map 构建的条件来更新数据。
int	updateByQuery(T entity, boolean ignoreNulls, QueryWrapper queryWrapper) 根据查询条件来更新数据。
default int	updateByQuery(T entity, QueryWrapper queryWrapper) 根据查询条件来更新数据。
default <E> Page<E>	xmlPaginate(String dataSelectId, Page<E> page, Map<String,Object> otherParams)
default <E> Page<E>	xmlPaginate(String dataSelectId, Page<E> page, QueryWrapper queryWrapper)
default <E> Page<E>	xmlPaginate(String dataSelectId, Page<E> page, QueryWrapper queryWrapper, Map<String,Object> otherParams)
default <E> Page<E>	xmlPaginate(String dataSelectId, String countSelectId, Page<E> page, QueryWrapper queryWrapper, Map<String,Object> otherParams)

字段详细资料

DEFAULT_BATCH_SIZE

static final int DEFAULT_BATCH_SIZE

默认批量处理切片数量。

另请参阅:

常量字段值

方法详细资料

insert

default int insert(T entity)

插入实体类数据，不忽略 null 值。

参数:

entity - 实体类

返回:

受影响的行数

insertSelective

default int insertSelective(T entity)

插入实体类数据，但是忽略 null 的数据，只对有值的内容进行插入。 这样的好处是数据库已经配置了一些默认值，这些默认值才会生效。

参数:

entity - 实体类

返回:

受影响的行数

insert

@InsertProvider(type=EntitySqlProvider.class,
                method="insert")
int insert(@Param(value="$$entity")
                                                                                          T entity,
                                                                                          @Param(value="$$ignoreNulls")
                                                                                          boolean ignoreNulls)

插入实体类数据。

参数:

entity - 实体类

ignoreNulls - 是否忽略 null 值

返回:

受影响的行数

另请参阅:

EntitySqlProvider.insert(Map, ProviderContext)

insertWithPk

default int insertWithPk(T entity)

插入带有主键的实体类，不忽略 null 值。

参数:

entity - 实体类

返回:

受影响的行数

insertSelectiveWithPk

default int insertSelectiveWithPk(T entity)

插入带有主键的实体类，忽略 null 值。

参数:

entity - 实体类

返回:

受影响的行数

insertWithPk

@InsertProvider(type=EntitySqlProvider.class,
                method="insertWithPk")
int insertWithPk(@Param(value="$$entity")
                                                                                                      T entity,
                                                                                                      @Param(value="$$ignoreNulls")
                                                                                                      boolean ignoreNulls)

带有主键的插入，此时实体类不会经过主键生成器生成主键。

参数:

entity - 带有主键的实体类

ignoreNulls - 是否忽略 null 值

返回:

受影响的行数

另请参阅:

EntitySqlProvider.insertWithPk(Map, ProviderContext)

insertBatch

@InsertProvider(type=EntitySqlProvider.class,
                method="insertBatch")
int insertBatch(@Param(value="$$entities")
                                                                                                    List<T> entities)

批量插入实体类数据，只会根据第一条数据来构建插入的字段内容。

参数:

entities - 插入的数据列表

返回:

受影响的行数

另请参阅:

EntitySqlProvider.insertBatch(Map, ProviderContext), FlexConsts.METHOD_INSERT_BATCH

insertBatch

default int insertBatch(List<T> entities,
                        int size)

批量插入实体类数据，按 size 切分。

参数:

entities - 插入的数据列表

size - 切分大小

返回:

受影响的行数

insertOrUpdate

default int insertOrUpdate(T entity)

插入或者更新，若主键有值，则更新，若没有主键值，则插入，插入或者更新都不会忽略 null 值。

参数:

entity - 实体类

返回:

受影响的行数

insertOrUpdateSelective

default int insertOrUpdateSelective(T entity)

插入或者更新，若主键有值，则更新，若没有主键值，则插入，插入或者更新都会忽略 null 值。

参数:

entity - 实体类

返回:

受影响的行数

insertOrUpdate

default int insertOrUpdate(T entity,
                           boolean ignoreNulls)

插入或者更新，若主键有值，则更新，若没有主键值，则插入。

参数:

entity - 实体类

ignoreNulls - 是否忽略 null 值

返回:

受影响的行数

delete

default int delete(T entity)

根据实体主键来删除数据。

参数:

entity - 实体对象，必须包含有主键

返回:

受影响的行数

deleteById

@DeleteProvider(type=EntitySqlProvider.class,
                method="deleteById")
int deleteById(@Param(value="$$primaryValue")
                                                                                                  Serializable id)

根据主键删除数据。如果是多个主键的情况下，需要传入数组，例如：new Integer[]{100,101}。

参数:

id - 主键数据

返回:

受影响的行数

另请参阅:

EntitySqlProvider.deleteById(Map, ProviderContext)

deleteBatchByIds

@DeleteProvider(type=EntitySqlProvider.class,
                method="deleteBatchByIds")
int deleteBatchByIds(@Param(value="$$primaryValue")
                                                                                                              Collection<? extends Serializable> ids)

根据多个主键批量删除数据。

参数:

ids - 主键列表

返回:

受影响的行数

另请参阅:

EntitySqlProvider.deleteBatchByIds(Map, ProviderContext)

deleteBatchByIds

default int deleteBatchByIds(List<? extends Serializable> ids,
                             int size)

根据多个主键批量删除数据。

参数:

ids - 主键列表

size - 切分大小

返回:

受影响的行数

另请参阅:

EntitySqlProvider.deleteBatchByIds(Map, ProviderContext)

deleteByMap

default int deleteByMap(Map<String,Object> whereConditions)

根据 Map 构建的条件来删除数据。

参数:

whereConditions - 条件

返回:

受影响的行数

deleteByCondition

default int deleteByCondition(QueryCondition whereConditions)

根据查询条件来删除数据。

参数:

whereConditions - 条件

返回:

受影响的行数

deleteByQuery

@DeleteProvider(type=EntitySqlProvider.class,
                method="deleteByQuery")
int deleteByQuery(@Param(value="$$query")
                                                                                                        QueryWrapper queryWrapper)

根据查询条件来删除数据。

参数:

queryWrapper - 条件

返回:

受影响的行数

另请参阅:

EntitySqlProvider.deleteByQuery(Map, ProviderContext)

update

default int update(T entity)

根据主键来更新数据，若实体类属性数据为 null，该属性不会更新到数据库。

参数:

entity - 数据内容，必须包含有主键

返回:

受影响的行数

update

@UpdateProvider(type=EntitySqlProvider.class,
                method="update")
int update(@Param(value="$$entity")
                                                                                          T entity,
                                                                                          @Param(value="$$ignoreNulls")
                                                                                          boolean ignoreNulls)

根据主键来更新数据到数据库。

参数:

entity - 数据内容，必须包含有主键

ignoreNulls - 是否忽略空内容字段

返回:

受影响的行数

另请参阅:

EntitySqlProvider.update(Map, ProviderContext)

updateByMap

default int updateByMap(T entity,
                        Map<String,Object> whereConditions)

根据 Map 构建的条件来更新数据。

参数:

entity - 实体类

whereConditions - 条件

返回:

受影响的行数

updateByMap

default int updateByMap(T entity,
                        boolean ignoreNulls,
                        Map<String,Object> whereConditions)

根据 Map 构建的条件来更新数据。

参数:

entity - 实体类

ignoreNulls - 是否忽略 null 数据

whereConditions - 条件

返回:

受影响的行数

updateByCondition

default int updateByCondition(T entity,
                              QueryCondition whereConditions)

根据查询条件来更新数据。

参数:

entity - 实体类

whereConditions - 条件

返回:

受影响的行数

updateByCondition

default int updateByCondition(T entity,
                              boolean ignoreNulls,
                              QueryCondition whereConditions)

根据查询条件来更新数据。

参数:

entity - 实体类

ignoreNulls - 是否忽略 null 数据

whereConditions - 条件

返回:

受影响的行数

updateByQuery

default int updateByQuery(T entity,
                          QueryWrapper queryWrapper)

根据查询条件来更新数据。

参数:

entity - 实体类

queryWrapper - 条件

返回:

受影响的行数

updateByQuery

@UpdateProvider(type=EntitySqlProvider.class,
                method="updateByQuery")
int updateByQuery(@Param(value="$$entity")
                                                                                                        T entity,
                                                                                                        @Param(value="$$ignoreNulls")
                                                                                                        boolean ignoreNulls,
                                                                                                        @Param(value="$$query")
                                                                                                        QueryWrapper queryWrapper)

根据查询条件来更新数据。

参数:

entity - 实体类

ignoreNulls - 是否忽略空值

queryWrapper - 条件

返回:

受影响的行数

另请参阅:

EntitySqlProvider.updateByQuery(Map, ProviderContext)

selectOneByEntityId

default T selectOneByEntityId(T entity)

根据实体主键查询数据。

参数:

entity - 实体对象，必须包含有主键

返回:

实体类数据

selectOneById

@SelectProvider(type=EntitySqlProvider.class,
                method="selectOneById")
T selectOneById(@Param(value="$$primaryValue")
                                                                                                      Serializable id)

根据主键查询数据。

参数:

id - 主键

返回:

实体类数据

另请参阅:

EntitySqlProvider.selectOneById(Map, ProviderContext)

selectOneByMap

default T selectOneByMap(Map<String,Object> whereConditions)

根据 Map 构建的条件来查询数据。

参数:

whereConditions - 条件

返回:

实体类数据

selectOneByCondition

default T selectOneByCondition(QueryCondition whereConditions)

根据查询条件查询数据。

参数:

whereConditions - 条件

返回:

实体类数据

selectOneByQuery

default T selectOneByQuery(QueryWrapper queryWrapper)

根据查询条件来查询 1 条数据。

参数:

queryWrapper - 条件

返回:

实体类数据

selectOneByQueryAs

default <R> R selectOneByQueryAs(QueryWrapper queryWrapper,
                                 Class<R> asType)

根据查询条件来查询 1 条数据。

参数:

queryWrapper - 条件

asType - 接收数据类型

返回:

实体类数据

selectOneWithRelationsByMap

default T selectOneWithRelationsByMap(Map<String,Object> whereConditions)

根据 Map 构建的条件来查询 1 条数据。

参数:

whereConditions - 条件

返回:

实体类数据

selectOneWithRelationsByCondition

default T selectOneWithRelationsByCondition(QueryCondition whereConditions)

根据查询条件查询 1 条数据。

参数:

whereConditions - 条件

返回:

实体类数据

selectOneWithRelationsByQuery

default T selectOneWithRelationsByQuery(QueryWrapper queryWrapper)

根据查询条件来查询 1 条数据。

参数:

queryWrapper - 条件

返回:

实体类数据

selectOneWithRelationsById

default T selectOneWithRelationsById(Serializable id)

根据主表主键来查询 1 条数据。

参数:

id - 主表主键

返回:

实体类数据

selectOneWithRelationsByIdAs

default <R> R selectOneWithRelationsByIdAs(Serializable id,
                                           Class<R> asType)

根据主表主键来查询 1 条数据。

参数:

id - 表主键

asType - 接收数据类型

返回:

实体类数据

selectOneWithRelationsByQueryAs

default <R> R selectOneWithRelationsByQueryAs(QueryWrapper queryWrapper,
                                              Class<R> asType)

根据查询条件来查询 1 条数据。

参数:

queryWrapper - 条件

asType - 接收数据类型

返回:

实体类数据

selectListByIds

@SelectProvider(type=EntitySqlProvider.class,
                method="selectListByIds")
List<T> selectListByIds(@Param(value="$$primaryValue")
                                                                                                                Collection<? extends Serializable> ids)

根据多个主键来查询多条数据。

参数:

ids - 主键列表

返回:

数据列表

另请参阅:

EntitySqlProvider.selectListByIds(Map, ProviderContext)

selectListByMap

default List<T> selectListByMap(Map<String,Object> whereConditions)

根据 Map 来构建查询条件，查询多条数据。

参数:

whereConditions - 条件

返回:

数据列表

selectListByMap

default List<T> selectListByMap(Map<String,Object> whereConditions,
                                Long count)

根据 Map 来构建查询条件，查询多条数据。

参数:

whereConditions - 条件

count - 数据量

返回:

数据列表

selectListByCondition

default List<T> selectListByCondition(QueryCondition whereConditions)

根据查询条件查询多条数据。

参数:

whereConditions - 条件

返回:

数据列表

selectListByCondition

default List<T> selectListByCondition(QueryCondition whereConditions,
                                      Long count)

根据查询条件查询多条数据。

参数:

whereConditions - 条件

count - 数据量

返回:

数据列表

selectListByQuery

@SelectProvider(type=EntitySqlProvider.class,
                method="selectListByQuery")
List<T> selectListByQuery(@Param(value="$$query")
                                                                                                                    QueryWrapper queryWrapper)

根据查询条件查询数据列表。

参数:

queryWrapper - 条件

返回:

数据列表

另请参阅:

EntitySqlProvider.selectListByQuery(Map, ProviderContext)

selectListByQuery

default List<T> selectListByQuery(QueryWrapper queryWrapper,
                                  Consumer<FieldQueryBuilder<T>>... consumers)

根据查询条件查询数据列表。

参数:

queryWrapper - 条件

consumers - 字段查询

返回:

数据列表

selectCursorByQuery

@SelectProvider(type=EntitySqlProvider.class,
                method="selectListByQuery")
org.apache.ibatis.cursor.Cursor<T> selectCursorByQuery(@Param(value="$$query")
                                                                                                                                                 QueryWrapper queryWrapper)

根据查询条件查询游标数据，该方法必须在事务中才能正常使用，非事务下无法获取数据。

参数:

queryWrapper - 条件

返回:

游标数据

selectRowsByQuery

@SelectProvider(type=EntitySqlProvider.class,
                method="selectListByQuery")
List<Row> selectRowsByQuery(@Param(value="$$query")
                                                                                                                      QueryWrapper queryWrapper)

根据查询条件查询 Row 数据。

参数:

queryWrapper - 条件

返回:

行数据

selectListByQueryAs

default <R> List<R> selectListByQueryAs(QueryWrapper queryWrapper,
                                        Class<R> asType)

根据查询条件查询数据列表，要求返回的数据为 asType。这种场景一般用在 left join 时， 有多出了实体类本身的字段内容，可以转换为 dto、vo 等场景。

参数:

queryWrapper - 条件

asType - 接收数据类型

返回:

数据列表

selectListByQueryAs

default <R> List<R> selectListByQueryAs(QueryWrapper queryWrapper,
                                        Class<R> asType,
                                        Consumer<FieldQueryBuilder<R>>... consumers)

根据查询条件查询数据列表，要求返回的数据为 asType 类型。

参数:

queryWrapper - 条件

asType - 接收的数据类型

consumers - 字段查询

返回:

数据列表

selectListWithRelationsByQuery

default List<T> selectListWithRelationsByQuery(QueryWrapper queryWrapper)

查询实体类及其 Relation 注解字段。

参数:

queryWrapper - 条件

selectListWithRelationsByQueryAs

default <R> List<R> selectListWithRelationsByQueryAs(QueryWrapper queryWrapper,
                                                     Class<R> asType)

查询实体类及其 Relation 注解字段。

参数:

queryWrapper - 条件

asType - 要求返回的数据类型

返回:

数据列表

selectListWithRelationsByQueryAs

default <R> List<R> selectListWithRelationsByQueryAs(QueryWrapper queryWrapper,
                                                     Class<R> asType,
                                                     Consumer<FieldQueryBuilder<R>>... consumers)

查询实体类及其 Relation 注解字段。

参数:

queryWrapper - 条件

asType - 返回的类型

consumers - 字段查询

返回:

数据列表

selectAll

default List<T> selectAll()

查询全部数据。

返回:

数据列表

selectAllWithRelations

default List<T> selectAllWithRelations()

查询全部数据，及其 Relation 字段内容。

返回:

数据列表

selectObjectByQuery

default Object selectObjectByQuery(QueryWrapper queryWrapper)

查询第一列返回的数据，QueryWrapper 执行的结果应该只有 1 列，例如：
QueryWrapper.create().select(ACCOUNT.id).where(...);

参数:

queryWrapper - 查询包装器

返回:

数据量

selectObjectByQueryAs

default <R> R selectObjectByQueryAs(QueryWrapper queryWrapper,
                                    Class<R> asType)

查询第一列返回的数据，QueryWrapper 执行的结果应该只有 1 列，例如：
QueryWrapper.create().select(ACCOUNT.id).where(...);

参数:

queryWrapper - 查询包装器

asType - 转换成的数据类型

返回:

数据量

selectObjectListByQuery

@SelectProvider(type=EntitySqlProvider.class,
                method="selectObjectByQuery")
List<Object> selectObjectListByQuery(@Param(value="$$query")
                                                                                                                                 QueryWrapper queryWrapper)

查询第一列返回的数据集合，QueryWrapper 执行的结果应该只有 1 列，例如：
QueryWrapper.create().select(ACCOUNT.id).where(...);

参数:

queryWrapper - 查询包装器

返回:

数据列表

另请参阅:

EntitySqlProvider.selectObjectByQuery(Map, ProviderContext)

selectObjectListByQueryAs

default <R> List<R> selectObjectListByQueryAs(QueryWrapper queryWrapper,
                                              Class<R> asType)

查询第一列返回的数据集合，QueryWrapper 执行的结果应该只有 1 列，例如：
QueryWrapper.create().select(ACCOUNT.id).where(...);

参数:

queryWrapper - 查询包装器

asType - 转换成的数据类型

返回:

数据列表

selectCountByQuery

default long selectCountByQuery(QueryWrapper queryWrapper)

查询数据量。

参数:

queryWrapper - 条件

返回:

数据量

selectCountByCondition

default long selectCountByCondition(QueryCondition whereConditions)

根据条件查询数据总量。

参数:

whereConditions - 条件

返回:

数据量

paginate

default Page<T> paginate(Number pageNumber,
                         Number pageSize,
                         QueryWrapper queryWrapper)

分页查询。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

queryWrapper - 条件

返回:

分页数据

paginateWithRelations

default Page<T> paginateWithRelations(Number pageNumber,
                                      Number pageSize,
                                      QueryWrapper queryWrapper)

分页查询，及其 Relation 字段内容。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

queryWrapper - 条件

返回:

分页数据

paginate

default Page<T> paginate(Number pageNumber,
                         Number pageSize,
                         QueryCondition whereConditions)

分页查询。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

whereConditions - 条件

返回:

分页数据

paginateWithRelations

default Page<T> paginateWithRelations(Number pageNumber,
                                      Number pageSize,
                                      QueryCondition whereConditions)

分页查询，及其 Relation 字段内容。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

whereConditions - 条件

返回:

分页数据

paginate

default Page<T> paginate(Number pageNumber,
                         Number pageSize,
                         Number totalRow,
                         QueryWrapper queryWrapper)

分页查询。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

totalRow - 数据总量

queryWrapper - 条件

返回:

分页数据

paginateWithRelations

default Page<T> paginateWithRelations(Number pageNumber,
                                      Number pageSize,
                                      Number totalRow,
                                      QueryWrapper queryWrapper)

分页查询，及其 Relation 字段内容。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

totalRow - 数据总量

queryWrapper - 条件

返回:

分页数据

paginate

default Page<T> paginate(Number pageNumber,
                         Number pageSize,
                         Number totalRow,
                         QueryCondition whereConditions)

分页查询。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

totalRow - 数据总量

whereConditions - 条件

返回:

分页数据

paginateWithRelations

default Page<T> paginateWithRelations(Number pageNumber,
                                      Number pageSize,
                                      Number totalRow,
                                      QueryCondition whereConditions)

分页查询，及其 Relation 字段内容。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

totalRow - 数据总量

whereConditions - 条件

返回:

分页数据

paginate

default Page<T> paginate(Page<T> page,
                         QueryWrapper queryWrapper)

分页查询。

参数:

page - 包含了页码、每页的数据量，可能包含数据总量

queryWrapper - 条件

返回:

page 数据

paginate

default Page<T> paginate(Page<T> page,
                         QueryWrapper queryWrapper,
                         Consumer<FieldQueryBuilder<T>>... consumers)

分页查询。

参数:

page - 包含了页码、每页的数据量，可能包含数据总量

queryWrapper - 条件

consumers - 字段查询

返回:

page 数据

paginateWithRelations

default Page<T> paginateWithRelations(Page<T> page,
                                      QueryWrapper queryWrapper)

分页查询，及其 Relation 字段内容。

参数:

page - 包含了页码、每页的数据量，可能包含数据总量

queryWrapper - 条件

返回:

分页数据

paginateWithRelations

default Page<T> paginateWithRelations(Page<T> page,
                                      QueryWrapper queryWrapper,
                                      Consumer<FieldQueryBuilder<T>>... consumers)

分页查询，及其 Relation 字段内容。

参数:

page - 包含了页码、每页的数据量，可能包含数据总量

queryWrapper - 条件

consumers - 字段查询

返回:

分页数据

paginateAs

default <R> Page<R> paginateAs(Number pageNumber,
                               Number pageSize,
                               QueryWrapper queryWrapper,
                               Class<R> asType)

分页查询。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

queryWrapper - 条件

asType - 接收数据类型

返回:

分页数据

paginateAs

default <R> Page<R> paginateAs(Number pageNumber,
                               Number pageSize,
                               Number totalRow,
                               QueryWrapper queryWrapper,
                               Class<R> asType)

分页查询。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

totalRow - 数据总量

queryWrapper - 条件

asType - 接收数据类型

返回:

分页数据

paginateAs

default <R> Page<R> paginateAs(Page<R> page,
                               QueryWrapper queryWrapper,
                               Class<R> asType)

分页查询。

参数:

page - 包含了页码、每页的数据量，可能包含数据总量

queryWrapper - 条件

asType - 接收数据类型

返回:

分页数据

paginateAs

default <R> Page<R> paginateAs(Page<R> page,
                               QueryWrapper queryWrapper,
                               Class<R> asType,
                               Consumer<FieldQueryBuilder<R>>... consumers)

分页查询。

参数:

page - 包含了页码、每页的数据量，可能包含数据总量

queryWrapper - 条件

asType - 接收数据类型

consumers - 字段查询

返回:

分页数据

paginateWithRelationsAs

default <R> Page<R> paginateWithRelationsAs(Number pageNumber,
                                            Number pageSize,
                                            QueryWrapper queryWrapper,
                                            Class<R> asType)

分页查询，及其 Relation 字段内容。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

queryWrapper - 条件

asType - 接收数据类型

返回:

分页数据

paginateWithRelationsAs

default <R> Page<R> paginateWithRelationsAs(Number pageNumber,
                                            Number pageSize,
                                            Number totalRow,
                                            QueryWrapper queryWrapper,
                                            Class<R> asType)

分页查询，及其 Relation 字段内容。

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

totalRow - 数据总量

queryWrapper - 条件

asType - 接收数据类型

返回:

分页数据

paginateWithRelationsAs

default <R> Page<R> paginateWithRelationsAs(Page<R> page,
                                            QueryWrapper queryWrapper,
                                            Class<R> asType)

分页查询，及其 Relation 字段内容。

参数:

page - 包含了页码、每页的数据量，可能包含数据总量

queryWrapper - 条件

asType - 接收数据类型

返回:

分页数据

paginateWithRelationsAs

default <R> Page<R> paginateWithRelationsAs(Page<R> page,
                                            QueryWrapper queryWrapper,
                                            Class<R> asType,
                                            Consumer<FieldQueryBuilder<R>>... consumers)

分页查询，及其 Relation 字段内容。

参数:

page - 包含了页码、每页的数据量，可能包含数据总量

queryWrapper - 条件

asType - 接收数据类型

consumers - 字段查询

返回:

分页数据

xmlPaginate

default <E> Page<E> xmlPaginate(String dataSelectId,
                                Page<E> page,
                                QueryWrapper queryWrapper)

xmlPaginate

default <E> Page<E> xmlPaginate(String dataSelectId,
                                Page<E> page,
                                Map<String,Object> otherParams)

xmlPaginate

default <E> Page<E> xmlPaginate(String dataSelectId,
                                Page<E> page,
                                QueryWrapper queryWrapper,
                                Map<String,Object> otherParams)

xmlPaginate

default <E> Page<E> xmlPaginate(String dataSelectId,
                                String countSelectId,
                                Page<E> page,
                                QueryWrapper queryWrapper,
                                Map<String,Object> otherParams)