org.beetl.sql.core

类 SQLManager

java.lang.Object

org.beetl.sql.core.SQLManager

所有已实现的接口:

DataAPI

直接已知子类:

ConditionalSQLManager, ThreadLocalSQLManager

public class SQLManager
extends Object
implements DataAPI

Beetsql 主要使用类。以检索SQL资源、载入sql模板、解析sql模板、执行解析结果、返回sql执行结果为核心
途经如下：

1. 手动传递SqlId 检索SQL模板
2. 通过java bean 构建sql
3. 手动传递sql模板
4. 通过Mapper接口反射方法名称检索SQL模板

作者:

xiandafu

另请参阅:

MapperBuilder, SqlId,SqlIdFactory,SQLLoader, SQLSource,SQLExecutor,SQLResult,SQLReady, BeanProcessor

字段概要

字段

限定符和类型	字段和说明
protected String	name sqlManager名字

构造器概要

构造器

限定符	构造器和说明
protected	SQLManager()

方法概要

限定符和类型	方法和说明
void	addIdAutoGen(String name, IDAutoGen algorithm) 设置一种id算法用于注解AssignId("xxx"),这样，对于应用赋值主键，交给beetlsql来处理了
void	addVirtualTable(String realTable, String virtualTable) 为不存在的表设置一个数据库真正的表，以用于获取metadata 主要用于数据库分库分表
<T> List<T>	all(Class<T> clazz) btsql自动生成查询语句，查询clazz代表的表的所有数据。
<T> List<T>	all(Class<T> clazz, Object start, Long pageSize)
long	allCount(Class<?> clazz) 查询记录数
protected void	assignAutoId(Object bean, Object id)
BigDecimal	bigDecimalValue(SqlId id, Object paras) 将查询结果返回成BigDecimal类型
boolean	containSqlId(SqlId sqlId)
int	deleteById(Class<?> clazz, Object pkValue) delete from user where 1=1 and id= #id# 根据Id删除数据：支持联合主键
int	deleteObject(Object obj) 删除对象, 通过对象的主键
<T> List<T>	execute(SqlId sqlId, String sqlTemplate, Class<T> clazz, Object paras) 直接执行语句,sql是模板 提供sqlId
<T> List<T>	execute(SqlId sqlId, String sqlTemplate, Class<T> clazz, Object paras, Object start, long size)
<T> List<T>	execute(SQLReady p, Class<T> clazz) 直接执行sql语句查询，sql语句已经是准备好的，采用preparedstatment执行
<T> PageResult<T>	execute(SQLReady p, Class<T> clazz, PageRequest<T> pageRequest) 本地分页查询
<T> List<T>	execute(String sqlTemplate, Class<T> clazz, Object paras) 直接执行语句,sql是模板
<T> List<T>	execute(String sqlTemplate, Class<T> clazz, Object paras, Object start, long size) 直接执行sql模版语句，sql是模板
int[]	executeBatchUpdate(SQLBatchReady batch)
<T> T	executeOnConnection(OnConnection<T> onConnection) 自己用Connection执行jdbc，通常用于存储过程调用，或者需要自己完全控制的jdbc
<T> PageResult<T>	executePageQuery(SqlId sqlId, String sqlTemplate, Class<T> clazz, Object paras, PageRequest<T> request)
<T> PageResult<T>	executePageQuery(String sqlTemplate, Class<T> clazz, Object paras, PageRequest<T> request) sql 模板分页查询，记得使用page函数
<T> T	executeQueryOne(SQLReady p, Class<T> clazz)
int	executeUpdate(SqlId sqlId, String sqlTemplate, Object paras)
int	executeUpdate(SQLReady p) 直接执行sql语句，用于删除或者更新，sql语句已经是准备好的，采用preparedstatment执行
int	executeUpdate(String sqlTemplate, Object paras) 直接执行sql更新，sql是模板
boolean	exist(Class<?> clazz, Object pk) 是否有此对象
<T> T	forceDataSource(DBRunner<T> runner) 强制使用某个数据源，DBRunner.MasterRunner，DBRunner.SlaveRunner或者继承DBRunner自定义.
protected int	generalInsert(Class clazz, Object paras, boolean template)
protected Object	getAssignIdByIdAutoGen(String name, String param, String table) 根据某种算法自动计算id
String	getCharset()
ClassDesc	getClassDesc(Class target)
ClassLoaderKit	getClassLoaderKit()
DBStyle	getDbStyle() 得到当前sqlmanager的数据库类型
BeanProcessor	getDefaultBeanProcessors() 得到默认的jdbc到bean的处理类
ConnectionSource	getDs()
Interceptor[]	getInters() 得到所有的Interceptor
<T> T	getMapper(Class<T> mapperInterface)
MapperBuilder	getMapperBuilder()
MetadataManager	getMetaDataManager() 得到MetaDataManager，用来获取数据库元数据，如表，列，主键等信息
String	getName()
NameConversion	getNc() 获取 NameConversion
protected SQLExecutor	getPageSqlScript(Class mapping, SqlId selectId) 获取为分页语句
Map<String,BeanProcessor>	getProcessors() 获取特殊的BeanPorcessor
SQLExecutor	getScript(Class<?> cls, AutoSQLEnum autoSQLEnum) 得到增删改查模板
SQLExecutor	getScript(SqlId sqlId) 得到指定sqlId的sqlscript对象
SqlIdFactory	getSqlIdFactory()
SQLLoader	getSqlLoader()
SQLManagerExtend	getSqlManagerExtend()
SQLResult	getSQLResult(SqlId id, Object paras) 不执行数据库操作，仅仅得到一个sql模板执行后的实际得sql和相应的参数
SQLResult	getSQLResult(SqlId id, Object paras, boolean isUpdate)
SQLResult	getSQLResult(SqlId id, Object paras, TemplateContext ctx)
SQLResult	getSQLResult(SQLSource source, Object inputParas) 内部使用，
SQLTemplateEngine	getSqlTemplateEngine() 得到sql模板引擎
TableDesc	getTableDesc(String table)
int	insert(Class clazz, Object paras) 插入一行记录
int	insert(Object paras) 通用插入操作
int	insert(SqlId sqlId, Object paras) 插入，并获取主键,主键将通过paras所代表的表名来获取
Object[]	insert(SqlId sqlId, Object paras, String[] cols) 插入单条，并获取自增主键值，因为此接口并未指定实体对象，因此需要keyName来指明数据库主键列 对于一次插入多条，不支持TODO，需要试一下
int[]	insertBatch(Class clazz, List<?> list) 批量插入
int	insertTemplate(Class clazz, Object paras) 模板插入，非空值插入到数据库，并且获取到自增主键的值
int	insertTemplate(Object paras) 通用模板插入
Integer	intValue(SqlId id, Object paras) 将查询结果返回成Integer类型
boolean	isOffsetStartZero()
boolean	isProduct()
boolean	isProductMode() 是否是生产模式:生产模式MetadataManager ，不查看sql文件变化,默认是false
boolean	isQueryLogicDeleteEnable()
<T> LambdaQuery<T>	lambdaQuery(Class<T> clazz)
<T> T	lock(Class<T> clazz, Object pk) 一个行级锁实现，类似select * from xx where id = ?
Long	longValue(SqlId id, Object paras) 将查询结果返回成Long类型
static SQLManagerBuilder	newBuilder(ConnectionSource ds) 使用这个创建更加的简洁, 并且用户不需要理解更多的 构造函数
static SQLManagerBuilder	newBuilder(String driver, String url, String userName, String password) 快速上手的简洁构建器
<T> PageResult<T>	pageQuery(SqlId sqlId, Class<T> clazz, Object paras, PageRequest request)
<T> Query<T>	query(Class<T> clazz)
void	refresh() 清空sqlmanager，只能适用于开发模式，比如数据库在线调整后，生成的sql，缓存的数据库定义发生变化
void	register()
SQLManager	resultSetMapper(Class resultSetMapperClass)
SQLManager	rowMapper(Class rowMapperClass)
<T> List<T>	select(SqlId sqlId, Class<T> clazz) 根据sqlId查询目标对象
<T> List<T>	select(SqlId sqlId, Class<T> clazz, Object paras) 通过sqlId进行查询，查询结果映射到clazz上，输入条件是个Bean， Bean的属性可以被sql语句引用，如bean中有name属性,即方法getName,则sql语句可以包含 name属性，如select * from xxx where name = #name#
<T> List<T>	select(SqlId sqlId, Object paras, Class<T> clazz, Object start, long size)
<T> List<T>	selectByIds(Class<T> clazz, List<?> pks)
<T> T	selectSingle(SqlId sqlId, Object paras, Class<T> target) 返回查询的第一行数据，如果有未找到，返回null
<T> T	selectUnique(SqlId id, Object paras, Class<T> target) 返回一行数据，如果有多行或者未找到，抛错
void	setCharset(String charset)
void	setClassLoaderKit(ClassLoaderKit classLoaderKit) 设置classloder，如果没有，pojo的初始化使用ContextClassLoader或者加载Beetlsql的classLoader
void	setDbStyle(DBStyle dbStyle)
void	setDefaultBeanProcessors(BeanProcessor defaultBeanProcessors) 设置默认的jdbc 到 bean的映射处理类，用户可以自己扩展处理最新的类型
void	setDs(ConnectionSource ds) 设置ConnectionSource，参考ConnectionSourceHelper
void	setInters(Interceptor[] inters) 设置Interceptor
void	setMapperBuilder(MapperBuilder mapperBuilder)
void	setMetaDataManager(MetadataManager metaDataManager)
void	setName(String name)
void	setNc(NameConversion nc) 设置NameConversion
void	setProcessors(Map<String,BeanProcessor> processors) 为指定的sqlId提供一个处理类，可以既可以是一个sqlId，也可以是namespace部分， 所有属于namesapce的都会被此BeanProcessor 处理
void	setProduct(boolean product)
void	setQueryLogicDeleteEnable(boolean queryLogicDeleteEnable)
void	setSqlIdFactory(SqlIdFactory sqlIdFactory)
void	setSqlLoader(SQLLoader sqlLoader)
void	setSqlManagerExtend(SQLManagerExtend sqlManagerExtend)
void	setSQLTemplateEngine(SQLTemplateEngine sqlTemplateEngine)
<T> T	single(Class<T> clazz, Object pk)
<T> StreamData<T>	stream(SqlId sqlId, Class<T> clazz, Object paras)
<T> StreamData<T>	streamExecute(SqlId sqlId, String sqlTemplate, Class<T> clazz, Object para)
<T> StreamData<T>	streamExecute(SQLReady p, Class<T> clazz) 返回一个流，适合处理超大量数据,此类必须再事务类处理完毕，不能脱离事务管理框架，参考StreamData#next方法，对事务判断
<T> StreamData<T>	streamExecute(String sqlTemplate, Class<T> clazz, Object para)
<T> List<T>	template(T t)
protected <T> long	templateCount(Class<T> target, Object paras)
<T> long	templateCount(T t) 查询总数
<T> T	templateOne(T t)
<T> T	unique(Class<T> clazz, Object pk) 根据主键查询 获取唯一记录，如果纪录不存在，将会抛出异常
int	update(SqlId sqlId) 执行sql更新（或者删除）操作
int	update(SqlId sqlId, Map<String,Object> paras) 执行sql更新（或者删除语句)
int	update(SqlId sqlId, Object obj) 执行sql更新（或者删除）操作
int	updateAll(Class<?> clazz, Object param) 更新指定表
int[]	updateBatch(SqlId sqlId, List<?> list) 对pojo批量更新执行sql更新语句，list包含的对象是作为参数，所有属性参与更新
int[]	updateBatchTemplateById(Class clz, List<?> list) 批量模板更新方式，list包含的对象是作为参数，非空属性参与更新
int	updateById(Object obj) 更新一个对象
int[]	updateByIdBatch(List<?> list) 批量更新
int	updateRawById(Object obj) 同updateById，但忽略@Version，@UpdateIgnore注解
int	updateTemplateById(Class c, Map paras)
int	updateTemplateById(Class c, Object obj) 按照模板更新
int	updateTemplateById(Object obj) 为null的值不参与更新，如果想更新null值，请使用updateById
boolean	upsert(Object obj) 先判断是否主键为空，如果为空，则插入，如果不为空，则从数据库 出一条，如果未取到，则插入一条，其他情况按照主键更新
protected boolean	upsert(Object obj, boolean template) 先判断是否主键为空，如果为空，则插入，如果不为空，则从数据库 取出一条，如果未取到，则插入一条，其他情况按照主键更新
boolean	upsertByTemplate(Object obj) 先判断是否主键为空，如果为空，则插入，如果不为空，则从数据库 取出一条，如果未取到，则插入一条，其他情况按照主键更新
SQLManager	use(String name)
SQLErrorInfo	validateSqlId(SqlId id)
SQLManager	viewType(Class view)

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

name

protected String name

sqlManager名字

构造器详细资料

SQLManager

protected SQLManager()

方法详细资料

newBuilder

public static SQLManagerBuilder newBuilder(ConnectionSource ds)

使用这个创建更加的简洁, 并且用户不需要理解更多的 构造函数

参数:

ds - 数据源

返回:

SQLManager构建器

newBuilder

public static SQLManagerBuilder newBuilder(String driver,
                                           String url,
                                           String userName,
                                           String password)

快速上手的简洁构建器

参数:

driver - 驱动

url - url

userName - userName

password - password

返回:

SQLManager构建器

query

public <T> Query<T> query(Class<T> clazz)

指定者:

query 在接口中 DataAPI

lambdaQuery

public <T> LambdaQuery<T> lambdaQuery(Class<T> clazz)

指定者:

lambdaQuery 在接口中 DataAPI

isOffsetStartZero

public boolean isOffsetStartZero()

isProductMode

public boolean isProductMode()

是否是生产模式:生产模式MetadataManager ，不查看sql文件变化,默认是false

返回:

ture表示不检测sql变化

getSQLResult

public SQLResult getSQLResult(SqlId id,
                              Object paras)

不执行数据库操作，仅仅得到一个sql模板执行后的实际得sql和相应的参数

参数:

id -

paras -

返回:

getSQLResult

public SQLResult getSQLResult(SqlId id,
                              Object paras,
                              boolean isUpdate)

getSQLResult

public SQLResult getSQLResult(SQLSource source,
                              Object inputParas)

内部使用，

参数:

source -

inputParas -

返回:

getSQLResult

public SQLResult getSQLResult(SqlId id,
                              Object paras,
                              TemplateContext ctx)

getScript

public SQLExecutor getScript(SqlId sqlId)

得到指定sqlId的sqlscript对象

参数:

sqlId -

返回:

containSqlId

public boolean containSqlId(SqlId sqlId)

validateSqlId

public SQLErrorInfo validateSqlId(SqlId id)

指定者:

validateSqlId 在接口中 DataAPI

viewType

public SQLManager viewType(Class view)

resultSetMapper

public SQLManager resultSetMapper(Class resultSetMapperClass)

rowMapper

public SQLManager rowMapper(Class rowMapperClass)

getScript

public SQLExecutor getScript(Class<?> cls,
                             AutoSQLEnum autoSQLEnum)

得到增删改查模板

参数:

cls - clz

autoSQLEnum - ConstantEnum

返回:

BaseSQLExecutor

getPageSqlScript

protected SQLExecutor getPageSqlScript(Class mapping,
                                       SqlId selectId)

获取为分页语句

参数:

selectId -

返回:

select

public <T> List<T> select(SqlId sqlId,
                          Class<T> clazz,
                          Object paras)

通过sqlId进行查询，查询结果映射到clazz上，输入条件是个Bean， Bean的属性可以被sql语句引用，如bean中有name属性,即方法getName,则sql语句可以包含 name属性，如select * from xxx where name = #name#

指定者:

select 在接口中 DataAPI

参数:

sqlId - sql标记

clazz - 结果集对应映射的Pojo类

paras - Bean

返回:

Pojo集合

select

public <T> List<T> select(SqlId sqlId,
                          Class<T> clazz)

根据sqlId查询目标对象

指定者:

select 在接口中 DataAPI

参数:

sqlId -

clazz -

返回:

pageQuery

public <T> PageResult<T> pageQuery(SqlId sqlId,
                                   Class<T> clazz,
                                   Object paras,
                                   PageRequest request)

指定者:

pageQuery 在接口中 DataAPI

unique

public <T> T unique(Class<T> clazz,
                    Object pk)

根据主键查询 获取唯一记录，如果纪录不存在，将会抛出异常

指定者:

unique 在接口中 DataAPI

参数:

clazz -

pk - 主键

返回:

single

public <T> T single(Class<T> clazz,
                    Object pk)

指定者:

single 在接口中 DataAPI

参数:

clazz -

pk -

返回:

如果没有找到，返回null

selectByIds

public <T> List<T> selectByIds(Class<T> clazz,
                               List<?> pks)

指定者:

selectByIds 在接口中 DataAPI

lock

public <T> T lock(Class<T> clazz,
                  Object pk)

一个行级锁实现，类似select * from xx where id = ? for update

指定者:

lock 在接口中 DataAPI

参数:

clazz -

pk -

返回:

all

public <T> List<T> all(Class<T> clazz)

btsql自动生成查询语句，查询clazz代表的表的所有数据。

指定者:

all 在接口中 DataAPI

参数:

clazz -

返回:

allCount

public long allCount(Class<?> clazz)

查询记录数

指定者:

allCount 在接口中 DataAPI

参数:

clazz -

返回:

all

public <T> List<T> all(Class<T> clazz,
                       Object start,
                       Long pageSize)

指定者:

all 在接口中 DataAPI

templateOne

public <T> T templateOne(T t)

指定者:

templateOne 在接口中 DataAPI

template

public <T> List<T> template(T t)

指定者:

template 在接口中 DataAPI

templateCount

public <T> long templateCount(T t)

查询总数

指定者:

templateCount 在接口中 DataAPI

参数:

t -

返回:

templateCount

protected <T> long templateCount(Class<T> target,
                                 Object paras)

longValue

public Long longValue(SqlId id,
                      Object paras)

将查询结果返回成Long类型

指定者:

longValue 在接口中 DataAPI

参数:

id -

paras -

返回:

intValue

public Integer intValue(SqlId id,
                        Object paras)

将查询结果返回成Integer类型

指定者:

intValue 在接口中 DataAPI

参数:

id -

paras -

返回:

bigDecimalValue

public BigDecimal bigDecimalValue(SqlId id,
                                  Object paras)

将查询结果返回成BigDecimal类型

指定者:

bigDecimalValue 在接口中 DataAPI

参数:

id -

paras -

返回:

selectSingle

public <T> T selectSingle(SqlId sqlId,
                          Object paras,
                          Class<T> target)

返回查询的第一行数据，如果有未找到，返回null

指定者:

selectSingle 在接口中 DataAPI

参数:

sqlId -

paras -

target -

返回:

selectUnique

public <T> T selectUnique(SqlId id,
                          Object paras,
                          Class<T> target)

返回一行数据，如果有多行或者未找到，抛错

指定者:

selectUnique 在接口中 DataAPI

参数:

id -

paras -

target -

返回:

select

public <T> List<T> select(SqlId sqlId,
                          Object paras,
                          Class<T> clazz,
                          Object start,
                          long size)

指定者:

select 在接口中 DataAPI

deleteById

public int deleteById(Class<?> clazz,
                      Object pkValue)

delete from user where 1=1 and id= #id#

根据Id删除数据：支持联合主键

指定者:

deleteById 在接口中 DataAPI

参数:

clazz -

pkValue -

返回:

deleteObject

public int deleteObject(Object obj)

删除对象, 通过对象的主键

指定者:

deleteObject 在接口中 DataAPI

参数:

obj - 对象,必须包含了主键，实际上根据主键来删除

返回:

insert

public int insert(Object paras)

通用插入操作

指定者:

insert 在接口中 DataAPI

参数:

paras -

返回:

insertTemplate

public int insertTemplate(Object paras)

通用模板插入

指定者:

insertTemplate 在接口中 DataAPI

参数:

paras -

返回:

insert

public int insert(Class clazz,
                  Object paras)

插入一行记录

指定者:

insert 在接口中 DataAPI

参数:

clazz - 对应的表

paras - 对应的数据，可以是map,也可以是pojo

返回:

insertTemplate

public int insertTemplate(Class clazz,
                          Object paras)

模板插入，非空值插入到数据库，并且获取到自增主键的值

指定者:

insertTemplate 在接口中 DataAPI

参数:

clazz -

paras -

返回:

exist

public boolean exist(Class<?> clazz,
                     Object pk)

是否有此对象

指定者:

exist 在接口中 DataAPI

参数:

clazz -

pk - 主健

返回:

generalInsert

protected int generalInsert(Class clazz,
                            Object paras,
                            boolean template)

assignAutoId

protected void assignAutoId(Object bean,
                            Object id)

insertBatch

public int[] insertBatch(Class clazz,
                         List<?> list)

批量插入

指定者:

insertBatch 在接口中 DataAPI

参数:

clazz -

list -

insert

public int insert(SqlId sqlId,
                  Object paras)

插入，并获取主键,主键将通过paras所代表的表名来获取

指定者:

insert 在接口中 DataAPI

参数:

sqlId -

paras -

返回:

insert

public Object[] insert(SqlId sqlId,
                       Object paras,
                       String[] cols)

插入单条，并获取自增主键值，因为此接口并未指定实体对象，因此需要keyName来指明数据库主键列 对于一次插入多条，不支持TODO，需要试一下

指定者:

insert 在接口中 DataAPI

参数:

sqlId -

paras -

cols,需要得到数据库自动生成的值 -

upsert

public boolean upsert(Object obj)

先判断是否主键为空，如果为空，则插入，如果不为空，则从数据库 出一条，如果未取到，则插入一条，其他情况按照主键更新

指定者:

upsert 在接口中 DataAPI

参数:

obj -

返回:

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

upsertByTemplate

public boolean upsertByTemplate(Object obj)

先判断是否主键为空，如果为空，则插入，如果不为空，则从数据库 取出一条，如果未取到，则插入一条，其他情况按照主键更新

指定者:

upsertByTemplate 在接口中 DataAPI

参数:

obj -

返回:

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

upsert

protected boolean upsert(Object obj,
                         boolean template)

先判断是否主键为空，如果为空，则插入，如果不为空，则从数据库 取出一条，如果未取到，则插入一条，其他情况按照主键更新

参数:

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

template -

返回:

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

updateById

public int updateById(Object obj)

更新一个对象

指定者:

updateById 在接口中 DataAPI

参数:

obj -

返回:

updateRawById

public int updateRawById(Object obj)

同updateById，但忽略@Version，@UpdateIgnore注解

指定者:

updateRawById 在接口中 DataAPI

参数:

obj -

返回:

updateTemplateById

public int updateTemplateById(Object obj)

为null的值不参与更新，如果想更新null值，请使用updateById

指定者:

updateTemplateById 在接口中 DataAPI

参数:

obj -

返回:

返回更新的条数

updateTemplateById

public int updateTemplateById(Class c,
                              Map paras)

指定者:

updateTemplateById 在接口中 DataAPI

参数:

c - c对应的表名

paras - 参数，仅仅更新paras里包含的值，paras里必须带有主键的值作为更新条件

返回:

返回更新的条数

updateTemplateById

public int updateTemplateById(Class c,
                              Object obj)

按照模板更新

指定者:

updateTemplateById 在接口中 DataAPI

参数:

c -

obj -

返回:

updateByIdBatch

public int[] updateByIdBatch(List<?> list)

批量更新

指定者:

updateByIdBatch 在接口中 DataAPI

参数:

list,包含同一个类型的pojo -

返回:

update

public int update(SqlId sqlId,
                  Object obj)

执行sql更新（或者删除）操作

指定者:

update 在接口中 DataAPI

参数:

sqlId -

obj -

返回:

返回更新的条数

update

public int update(SqlId sqlId)

执行sql更新（或者删除）操作

指定者:

update 在接口中 DataAPI

参数:

sqlId -

返回:

返回更新的条数

update

public int update(SqlId sqlId,
                  Map<String,Object> paras)

执行sql更新（或者删除语句)

指定者:

update 在接口中 DataAPI

参数:

sqlId -

paras -

返回:

返回更新的条数

updateBatch

public int[] updateBatch(SqlId sqlId,
                         List<?> list)

对pojo批量更新执行sql更新语句，list包含的对象是作为参数，所有属性参与更新

指定者:

updateBatch 在接口中 DataAPI

参数:

sqlId -

list -

返回:

返回更新的条数

updateBatchTemplateById

public int[] updateBatchTemplateById(Class clz,
                                     List<?> list)

批量模板更新方式，list包含的对象是作为参数，非空属性参与更新

指定者:

updateBatchTemplateById 在接口中 DataAPI

参数:

clz -

list -

返回:

updateAll

public int updateAll(Class<?> clazz,
                     Object param)

更新指定表

指定者:

updateAll 在接口中 DataAPI

参数:

clazz -

param - 参数

返回:

execute

public <T> List<T> execute(String sqlTemplate,
                           Class<T> clazz,
                           Object paras)

直接执行语句,sql是模板

指定者:

execute 在接口中 DataAPI

参数:

sqlTemplate -

clazz -

paras -

返回:

execute

public <T> List<T> execute(SqlId sqlId,
                           String sqlTemplate,
                           Class<T> clazz,
                           Object paras)

直接执行语句,sql是模板 提供sqlId

指定者:

execute 在接口中 DataAPI

类型参数:

T -

参数:

sqlId -

sqlTemplate -

clazz -

paras -

返回:

getTableDesc

public TableDesc getTableDesc(String table)

getClassDesc

public ClassDesc getClassDesc(Class target)

execute

public <T> List<T> execute(String sqlTemplate,
                           Class<T> clazz,
                           Object paras,
                           Object start,
                           long size)

直接执行sql模版语句，sql是模板

指定者:

execute 在接口中 DataAPI

参数:

sqlTemplate -

clazz -

paras -

start -

size -

返回:

execute

public <T> List<T> execute(SqlId sqlId,
                           String sqlTemplate,
                           Class<T> clazz,
                           Object paras,
                           Object start,
                           long size)

指定者:

execute 在接口中 DataAPI

executePageQuery

public <T> PageResult<T> executePageQuery(String sqlTemplate,
                                          Class<T> clazz,
                                          Object paras,
                                          PageRequest<T> request)

sql 模板分页查询，记得使用page函数

指定者:

executePageQuery 在接口中 DataAPI

参数:

sqlTemplate - select #page(*)# from user where name=#userName# ....

clazz -

request -

返回:

executePageQuery

public <T> PageResult<T> executePageQuery(SqlId sqlId,
                                          String sqlTemplate,
                                          Class<T> clazz,
                                          Object paras,
                                          PageRequest<T> request)

指定者:

executePageQuery 在接口中 DataAPI

executeUpdate

public int executeUpdate(String sqlTemplate,
                         Object paras)

直接执行sql更新，sql是模板

指定者:

executeUpdate 在接口中 DataAPI

参数:

sqlTemplate -

paras -

返回:

executeUpdate

public int executeUpdate(SqlId sqlId,
                         String sqlTemplate,
                         Object paras)

指定者:

executeUpdate 在接口中 DataAPI

execute

public <T> List<T> execute(SQLReady p,
                           Class<T> clazz)

直接执行sql语句查询，sql语句已经是准备好的，采用preparedstatment执行

指定者:

execute 在接口中 DataAPI

参数:

clazz -

p -

返回:

返回查询结果

executeQueryOne

public <T> T executeQueryOne(SQLReady p,
                             Class<T> clazz)

指定者:

executeQueryOne 在接口中 DataAPI

streamExecute

public <T> StreamData<T> streamExecute(SQLReady p,
                                       Class<T> clazz)

返回一个流，适合处理超大量数据,此类必须再事务类处理完毕，不能脱离事务管理框架，参考StreamData#next方法，对事务判断

指定者:

streamExecute 在接口中 DataAPI

类型参数:

T -

参数:

p -

clazz -

返回:

streamExecute

public <T> StreamData<T> streamExecute(String sqlTemplate,
                                       Class<T> clazz,
                                       Object para)

指定者:

streamExecute 在接口中 DataAPI

streamExecute

public <T> StreamData<T> streamExecute(SqlId sqlId,
                                       String sqlTemplate,
                                       Class<T> clazz,
                                       Object para)

指定者:

streamExecute 在接口中 DataAPI

stream

public <T> StreamData<T> stream(SqlId sqlId,
                                Class<T> clazz,
                                Object paras)

指定者:

stream 在接口中 DataAPI

execute

public <T> PageResult<T> execute(SQLReady p,
                                 Class<T> clazz,
                                 PageRequest<T> pageRequest)

本地分页查询

指定者:

execute 在接口中 DataAPI

类型参数:

T -

参数:

p -

clazz -

pageRequest -

返回:

executeUpdate

public int executeUpdate(SQLReady p)

直接执行sql语句，用于删除或者更新，sql语句已经是准备好的，采用preparedstatment执行

指定者:

executeUpdate 在接口中 DataAPI

参数:

p -

返回:

返回更新条数

executeBatchUpdate

public int[] executeBatchUpdate(SQLBatchReady batch)

指定者:

executeBatchUpdate 在接口中 DataAPI

executeOnConnection

public <T> T executeOnConnection(OnConnection<T> onConnection)

自己用Connection执行jdbc，通常用于存储过程调用，或者需要自己完全控制的jdbc

参数:

onConnection -

返回:

forceDataSource

public <T> T forceDataSource(DBRunner<T> runner)

强制使用某个数据源，DBRunner.MasterRunner，DBRunner.SlaveRunner或者继承DBRunner自定义. 如下代码的，在主从库下，强制查询走主库

    sqlManager.forceDataSource(new DBRunner.MasterRunner(){
                public void run(SQLManager sqlManager){
                sqlManager.select .....
          }
    )
 

如下代码，强制更新从库

    sqlManager.forceDataSource(new DBRunner.SlaveRunner(){
                public void run(SQLManager sqlManager){
                sqlManager.update()
          }
    )
 

参数:

runner -

getSqlLoader

public SQLLoader getSqlLoader()

setSqlLoader

public void setSqlLoader(SQLLoader sqlLoader)

getDs

public ConnectionSource getDs()

setDs

public void setDs(ConnectionSource ds)

设置ConnectionSource，参考ConnectionSourceHelper

参数:

ds -

getNc

public NameConversion getNc()

获取 NameConversion

返回:

setNc

public void setNc(NameConversion nc)

设置NameConversion

参数:

nc -

getDbStyle

public DBStyle getDbStyle()

得到当前sqlmanager的数据库类型

返回:

setDbStyle

public void setDbStyle(DBStyle dbStyle)

getSqlTemplateEngine

public SQLTemplateEngine getSqlTemplateEngine()

得到sql模板引擎

返回:

getMetaDataManager

public MetadataManager getMetaDataManager()

得到MetaDataManager，用来获取数据库元数据，如表，列，主键等信息

返回:

setMetaDataManager

public void setMetaDataManager(MetadataManager metaDataManager)

getInters

public Interceptor[] getInters()

得到所有的Interceptor

返回:

setInters

public void setInters(Interceptor[] inters)

设置Interceptor

参数:

inters -

addIdAutoGen

public void addIdAutoGen(String name,
                         IDAutoGen algorithm)

设置一种id算法用于注解AssignId("xxx"),这样，对于应用赋值主键，交给beetlsql来处理了

参数:

name -

algorithm -

getAssignIdByIdAutoGen

protected Object getAssignIdByIdAutoGen(String name,
                                        String param,
                                        String table)

根据某种算法自动计算id

参数:

name -

param -

返回:

getProcessors

public Map<String,BeanProcessor> getProcessors()

获取特殊的BeanPorcessor

返回:

setProcessors

public void setProcessors(Map<String,BeanProcessor> processors)

为指定的sqlId提供一个处理类，可以既可以是一个sqlId，也可以是namespace部分， 所有属于namesapce的都会被此BeanProcessor 处理

参数:

processors -

getDefaultBeanProcessors

public BeanProcessor getDefaultBeanProcessors()

得到默认的jdbc到bean的处理类

返回:

setDefaultBeanProcessors

public void setDefaultBeanProcessors(BeanProcessor defaultBeanProcessors)

设置默认的jdbc 到 bean的映射处理类，用户可以自己扩展处理最新的类型

参数:

defaultBeanProcessors -

getMapper

public <T> T getMapper(Class<T> mapperInterface)

getClassLoaderKit

public ClassLoaderKit getClassLoaderKit()

setClassLoaderKit

public void setClassLoaderKit(ClassLoaderKit classLoaderKit)

设置classloder，如果没有，pojo的初始化使用ContextClassLoader或者加载Beetlsql的classLoader

参数:

classLoaderKit -

addVirtualTable

public void addVirtualTable(String realTable,
                            String virtualTable)

为不存在的表设置一个数据库真正的表，以用于获取metadata 主要用于数据库分库分表

参数:

virtualTable -

realTable -

getSqlIdFactory

public SqlIdFactory getSqlIdFactory()

setSqlIdFactory

public void setSqlIdFactory(SqlIdFactory sqlIdFactory)

getCharset

public String getCharset()

setCharset

public void setCharset(String charset)

isProduct

public boolean isProduct()

setProduct

public void setProduct(boolean product)

setSQLTemplateEngine

public void setSQLTemplateEngine(SQLTemplateEngine sqlTemplateEngine)

use

public SQLManager use(String name)

getName

public String getName()

setName

public void setName(String name)

register

public void register()

getMapperBuilder

public MapperBuilder getMapperBuilder()

setMapperBuilder

public void setMapperBuilder(MapperBuilder mapperBuilder)

getSqlManagerExtend

public SQLManagerExtend getSqlManagerExtend()

setSqlManagerExtend

public void setSqlManagerExtend(SQLManagerExtend sqlManagerExtend)

isQueryLogicDeleteEnable

public boolean isQueryLogicDeleteEnable()

setQueryLogicDeleteEnable

public void setQueryLogicDeleteEnable(boolean queryLogicDeleteEnable)

refresh

public void refresh()

清空sqlmanager，只能适用于开发模式，比如数据库在线调整后，生成的sql，缓存的数据库定义发生变化