org.beetl.sql.mapper

接口 BaseMapper<T>

类型参数:

T - the generic type

public interface BaseMapper<T>

BaseMapper.定义了一个Mapper接口，并内置了多个方法 开发者可以定义自己的"BaseMapper",并使用AutoMapper注解来申明这是内置的，beetlsql会调用其注解使用的接口

作者:

xiandafu

方法概要

限定符和类型	方法和说明
List<T>	all() 返回实体对应的所有数据库记录
long	allCount() 返回实体在数据库里的总数
LambdaQuery<T>	createLambdaQuery() 返回一个LambdaQuery对象
Query<T>	createQuery() 返回一个Query对象
int	deleteById(Object key) 根据主键删除对象，如果对象是复合主键，传入对象本生即可
List<T>	execute(String sql, Object... args) 执行一个jdbc sql模板查询
int	executeUpdate(String sql, Object... args) 执行一个更新的jdbc sql
default boolean	exist(Object key)
SQLManager	getSQLManager()
Class	getTargetEntity() 得到mapper的范型类
void	insert(T entity) 通用插入，插入一个实体对象到数据库，所以字段将参与操作，除非你使用ColumnIgnore注解 SqlResource
void	insertBatch(List<T> list) 批量插入实体。
void	insertTemplate(T entity) 插入实体到数据库，对于null值不做处理
T	lock(Object key) 根据主键获取对象，如果在事物中执行会添加数据库行级锁(select * from table where id = ?
List<T>	selectByIds(List<?> key) 根据一批主键查询
T	single(Object key) 根据主键获取对象，如果对象不存在，返回null
List<T>	template(T entity) 模板查询，返回符合模板得所有结果。
long	templateCount(T entity) 符合模板得个数
<T> T	templateOne(T entity) 模板查询，返回一条结果,如果没有，返回null
T	unique(Object key) 根据主键获取对象，如果对象不存在，则会抛出一个Runtime异常
int	updateById(T entity) 根据主键更新对象，所以属性都参与更新。
int	updateTemplateById(T entity) 根据主键更新对象，只有不为null的属性参与更新
boolean	upsert(T entity) 按照主键更新更新或插入,自增或者序列id自动赋值给entity
boolean	upsertByTemplate(T entity) 按照主键更新或插入，更新失败，会调用插入，属性为空的字段将不更新或者插入。

方法详细资料

insert

void insert(T entity)

通用插入，插入一个实体对象到数据库，所以字段将参与操作，除非你使用ColumnIgnore注解 SqlResource

参数:

entity -

insertTemplate

void insertTemplate(T entity)

插入实体到数据库，对于null值不做处理

参数:

entity -

insertBatch

void insertBatch(List<T> list)

批量插入实体。此方法不会获取自增主键的值，如果需要，建议不适用批量插入，适用

 insert(T entity,true);
 

参数:

list -

updateById

int updateById(T entity)

根据主键更新对象，所以属性都参与更新。也可以使用主键ColumnIgnore来控制更新的时候忽略此字段

参数:

entity -

返回:

updateTemplateById

int updateTemplateById(T entity)

根据主键更新对象，只有不为null的属性参与更新

参数:

entity -

返回:

upsert

boolean upsert(T entity)

按照主键更新更新或插入,自增或者序列id自动赋值给entity

参数:

entity - 待更新/插入的实体对象

返回:

如果是插入操作，返回true，如果是更新，返回false

upsertByTemplate

boolean upsertByTemplate(T entity)

按照主键更新或插入，更新失败，会调用插入，属性为空的字段将不更新或者插入。自增或者序列id自动赋值给entity

参数:

entity - 待更新/插入的实体对象

返回:

deleteById

int deleteById(Object key)

根据主键删除对象，如果对象是复合主键，传入对象本生即可

参数:

key -

返回:

unique

T unique(Object key)

根据主键获取对象，如果对象不存在，则会抛出一个Runtime异常

参数:

key -

返回:

single

T single(Object key)

根据主键获取对象，如果对象不存在，返回null

参数:

key -

返回:

selectByIds

List<T> selectByIds(List<?> key)

根据一批主键查询

参数:

key -

返回:

exist

default boolean exist(Object key)

lock

T lock(Object key)

根据主键获取对象，如果在事物中执行会添加数据库行级锁(select * from table where id = ? for update)，如果对象不存在，返回null

参数:

key -

返回:

all

List<T> all()

返回实体对应的所有数据库记录

返回:

allCount

long allCount()

返回实体在数据库里的总数

返回:

template

List<T> template(T entity)

模板查询，返回符合模板得所有结果。beetlsql将取出非null值（日期类型排除在外），从数据库找出完全匹配的结果集

参数:

entity -

返回:

templateOne

<T> T templateOne(T entity)

模板查询，返回一条结果,如果没有，返回null

参数:

entity -

返回:

templateCount

long templateCount(T entity)

符合模板得个数

参数:

entity -

返回:

execute

List<T> execute(String sql,
                Object... args)

执行一个jdbc sql模板查询

参数:

sql -

args -

返回:

executeUpdate

int executeUpdate(String sql,
                  Object... args)

执行一个更新的jdbc sql

参数:

sql -

args -

返回:

getSQLManager

SQLManager getSQLManager()

createQuery

Query<T> createQuery()

返回一个Query对象

返回:

createLambdaQuery

LambdaQuery<T> createLambdaQuery()

返回一个LambdaQuery对象

返回:

getTargetEntity

Class getTargetEntity()

得到mapper的范型类

返回: