org.beetl.sql.core

类 SQLManager

java.lang.Object

org.beetl.sql.core.SQLManager

public class SQLManager
extends Object

Beetsql 操作入口

作者:

xiandafu

构造器概要

构造器

构造器和说明
SQLManager(DBStyle dbStyle, ConnectionSource ds) 创建一个beetlsql需要的sqlmanager
SQLManager(DBStyle dbStyle, SQLLoader sqlLoader, ConnectionSource ds)
SQLManager(DBStyle dbStyle, SQLLoader sqlLoader, ConnectionSource ds, NameConversion nc)
SQLManager(DBStyle dbStyle, SQLLoader sqlLoader, ConnectionSource ds, NameConversion nc, Interceptor[] inters)
SQLManager(DBStyle dbStyle, SQLLoader sqlLoader, ConnectionSource ds, NameConversion nc, Interceptor[] inters, String defaultSchema)
SQLManager(DBStyle dbStyle, SQLLoader sqlLoader, ConnectionSource ds, NameConversion nc, Interceptor[] inters, String defaultSchema, Properties ps)
SQLManager(DBStyle dbStyle, SQLLoader sqlLoader, ConnectionSource ds, NameConversion nc, Interceptor[] inters, String defaultSchema, Properties ps, String name)

方法概要

限定符和类型	方法和说明
void	addIdAutonGen(String name, IDAutoGen alorithm) 设置一种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, long start, long size) btsql自动生成查询语句，查询clazz代表的表的所有数据。
<T> List<T>	all(Class<T> clazz, RowMapper<T> mapper) 查询所有记录
<T> List<T>	all(Class<T> clazz, RowMapper<T> mapper, long start, int end) 查询所有记录
long	allCount(Class<?> clazz) 查询记录数
protected void	assignAutoId(Object bean, Object id)
BigDecimal	bigDecimalValue(String id, Map<String,Object> paras) 将查询结果返回成BigDecimal类型
BigDecimal	bigDecimalValue(String id, Object paras) 将查询结果返回成BigDecimal类型
int	deleteById(Class<?> clazz, Object pkValue) delete from user where 1=1 and id= #id# 根据Id删除数据：支持联合主键
int	deleteObject(Object obj) 删除对象, 通过对象的主键
<T> List<T>	execute(SQLReady p, Class<T> clazz) 直接执行sql语句查询，sql语句已经是准备好的，采用preparedstatment执行
<T> PageQuery<T>	execute(SQLReady p, Class<T> clazz, PageQuery<T> pageQuery)
<T> List<T>	execute(String sqlTemplate, Class<T> clazz, Map paras) 直接执行sql查询语句，sql是模板
<T> List<T>	execute(String sqlTemplate, Class<T> clazz, Map paras, long start, long size) 直接执行sql模版语句，sql是模板
<T> List<T>	execute(String sqlTemplate, Class<T> clazz, Object paras) 直接执行语句,sql是模板
<T> List<T>	execute(String sqlTemplate, Class<T> clazz, Object paras, long start, long size) 直接执行sql模板查询，并获取指定范围的结果集
int[]	executeBatchUpdate(SQLBatchReady batch)
<T> T	executeOnConnection(OnConnection<T> onConnection) 自己用Connection执行jdbc，通常用于存储过程调用，或者需要自己完全控制的jdbc
<T> PageQuery<T>	executePageQuery(String sqlTemplate, Class<T> clazz, PageQuery<T> pageQuery) sql 模板分页查询，记得使用page函数
int	executeUpdate(SQLReady p) 直接执行sql语句，用于删除或者更新，sql语句已经是准备好的，采用preparedstatment执行
int	executeUpdate(String sqlTemplate, Map paras) 直接更新sql，sql是模板
int	executeUpdate(String sqlTemplate, Object paras) 直接执行sql更新，sql是模板
boolean	exist(Class<?> clazz, Object pk) 是否有此对象
void	genALL(String pkg, GenConfig config, GenFilter filter) 生成数据库的所有entity，dao，还有md文件，
void	genBuiltInSqlToConsole(Class cls) 生成内置的sql，插入，更新，主键查找，删除语句
void	genPojoCode(String table, String pkg) 生成pojo类,默认路径是当前工程src目录,或者是src/main/java 下
void	genPojoCode(String table, String pkg, GenConfig config) 同上，但路径自动根据项目当前目录推测，是src目录下，或者src/main/java 下
void	genPojoCode(String table, String pkg, String srcPath, GenConfig config) 根据表名生成对应的pojo类
void	genPojoCodeToConsole(String table) 仅仅打印pojo类到控制台，使用默认的包,建议使用genPojoCodeToConsole(String table,String pkg)
void	genPojoCodeToConsole(String table, GenConfig config) 仅仅打印pojo类到控制台
void	genPojoCodeToConsole(String table, String pkg) 仅仅打印pojo类到控制台
void	genSQLFile(String table, GenConfig config) 将sql模板文件输出到src下，如果采用的是ClasspathLoader，则使用ClasspathLoader的配置，否则， 生成到src的sql代码里
void	genSQLFile(String table, String alias, GenConfig config)
void	genSQLTemplateToConsole(String table) 生成sql语句片段,包含了条件查询，列名列表，更新，插入等语句
void	genSQLTemplateToConsole(String table, String alias) 生成md到控制台，使用别名
protected Object	getAssignIdByIdAutonGen(String name, String param, String table) 根据某种算法自动计算id
Beetl	getBeetl() 得到beetl引擎
DBStyle	getDbStyle() 得到当前sqlmanager的数据库类型
BeanProcessor	getDefaultBeanProcessors() 得到默认的jdbc到bean的处理类
String	getDefaultSchema()
ConnectionSource	getDs()
ClassLoader	getEntityLoader()
Interceptor[]	getInters() 得到所有的Interceptor
<T> T	getMapper(Class<T> mapperInterface) 通过mapper接口生成dao代理
MapperBuilder	getMapperBuilder() 得到MapperBuilder,默认是DefaultMapperBuilder
MapperConfig	getMapperConfig()
MetadataManager	getMetaDataManager() 得到MetaDataManager，用来获取数据库元数据，如表，列，主键等信息
NameConversion	getNc() 获取 NameConversion
SQLScript	getPageSqlScript(String selectId) 获取为分页语句
Map<String,BeanProcessor>	getProcessors() 获取特殊的BeanPorcessor
SQLScript	getScript(Class<?> cls, ConstantEnum constantEnum) 得到增删改查模板
SQLScript	getScript(String id) 得到指定sqlId的sqlscript对象
SQLIdNameConversion	getSQLIdNameConversion()
SQLLoader	getSqlLoader()
static SQLManager	getSQLManagerByName(String name) 每个sqlManager都有个名称，如果未指定，默认是dbStyle 返回的名称，即数据库名
String	getSQLManagerName()
void	getSQLMetadata(String id, Object paras)
SQLResult	getSQLResult(SQLSource source, Map inputParas) 内部使用，
SQLResult	getSQLResult(String id, Map<String,Object> paras) 不执行数据库操作，仅仅得到一个sql模板执行后的实际得sql和相应的参数
SQLResult	getSQLResult(String id, Map<String,Object> paras, org.beetl.core.Context ctx)
SQLResult	getSQLResult(String id, Object paras) 不执行数据库操作，仅仅得到一个sql模板执行后的实际得sql和相应的参数
int	insert(Class<?> clazz, Object paras) 插入对象通用的方法，如果数据表有自增主键，需要获取到自增主键，参考使用 insert(Object paras,boolean autoAssignKey)，或者使用 带有KeyHolder的方法
int	insert(Class<?> clazz, Object paras, KeyHolder holder) 插入，并获取自增主键的值
int	insert(Class clazz, Object paras, boolean autoDbAssignKey) 对于有自增主键的表，插入一行记录
int	insert(Object paras) 通用插入操作
int	insert(Object paras, boolean autoDbAssignKey) 插入实体
int	insert(String sqlId, Class<?> clazz, Map paras, KeyHolder holder) 插入操作，数据库自增主键放到keyHolder里
int	insert(String sqlId, Map paras, KeyHolder holder, String keyName) 插入，并获取自增主键值，因为此接口并未指定实体对象，因此需要keyName来指明数据库主键列
int	insert(String sqlId, Object paras, KeyHolder holder) 插入，并获取主键,主键将通过paras所代表的表名来获取
int	insert(String sqlId, Object paras, KeyHolder holder, String keyName) 插入，并获取主键
int[]	insertBatch(Class clazz, List<?> list) 批量插入
int[]	insertBatch(Class clazz, List<?> list, boolean autoDbAssignKey)
int	insertTemplate(Class<?> clazz, Object paras, KeyHolder holder) 模板插入，仅仅插入非空属性，并获取自增主键
int	insertTemplate(Class clazz, Object paras, boolean autoDbAssignKey) 模板插入，非空值插入到数据库，并且获取到自增主键的值
int	insertTemplate(Object paras) 通用模板插入
int	insertTemplate(Object paras, boolean autoDbAssignKey) 模板插入，并根据autoAssignKey 自动获取自增主键值
Integer	intValue(String id, Map<String,Object> paras) 将查询结果返回成Integer类型
Integer	intValue(String id, Object paras) 将查询结果返回成Integer类型
boolean	isOffsetStartZero()
boolean	isProductMode() 是否是生产模式:生产模式MetadataManager ，不查看sql文件变化,默认是false
boolean	isRefreshReady()
<T> LambdaQuery<T>	lambdaQuery(Class<T> clazz)
<T> T	lock(Class<T> clazz, Object pk) 一个行级锁实现，类似select * from xx where id = ?
Long	longValue(String id, Map<String,Object> paras) 将查询结果返回成Long类型
Long	longValue(String id, Object paras) 将查询结果返回成Long类型
static SQLManagerBuilder	newBuilder(ConnectionSource ds) 使用这个创建更加的简洁, 并且用户不需要理解更多的 构造函数
static SQLManagerBuilder	newBuilder(String driver, String url, String userName, String password) 快速上手的简洁构建器
<T> PageQuery<T>	pageQuery(String sqlId, Class<T> clazz, PageQuery<T> query)
<T> PageQuery<T>	pageQuery(String sqlId, Class<T> clazz, PageQuery query, RowMapper<T> mapper) 翻页查询，假设有sqlId和sqlId$count 俩个sql存在，beetlsql会通过 这俩个sql来查询总数以及翻页操作，如果没有sqlId$count，则假设sqlId 包含了page函数或者标签 ，如 queryUser === select #page("a.
<T> Query<T>	query(Class<T> clazz)
void	refresh() 清空缓存，用于动态增加修改表情况下可以
<T> List<T>	select(String sqlId, Class<T> clazz) 根据sqlId查询目标对象
<T> List<T>	select(String sqlId, Class<T> clazz, Map<String,Object> paras) 通过sqlId进行查询,查询结果映射到clazz上
<T> List<T>	select(String sqlId, Class<T> clazz, Map<String,Object> paras, long start, long size) 翻页查询
<T> List<T>	select(String sqlId, Class<T> clazz, Map<String,Object> paras, RowMapper<T> mapper) 通过sqlId进行查询,查询结果映射到clazz上，mapper类可以定制映射
<T> List<T>	select(String sqlId, Class<T> clazz, Map<String,Object> paras, RowMapper<T> mapper, long start, long size) 翻页查询
<T> List<T>	select(String 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(String sqlId, Class<T> clazz, Object paras, long start, long size) 翻页查询
<T> List<T>	select(String sqlId, Class<T> clazz, Object paras, RowMapper<T> mapper) 通过sqlId进行查询:查询结果映射到clazz上，输入条件是个Bean, Bean的属性可以被sql语句引用，如bean中有name属性,即方法getName,则sql语句可以包含name属性， 如select * from xxx where name = #name#。
<T> List<T>	select(String sqlId, Class<T> clazz, Object paras, RowMapper<T> mapper, long start, long size) 翻页查询
<T> T	selectSingle(String sqlId, Map<String,Object> paras, Class<T> target) 返回查询的第一行数据，如果有未找到，返回null
<T> T	selectSingle(String sqlId, Object paras, Class<T> target) 返回查询的第一行数据，如果有未找到，返回null
<T> T	selectUnique(String id, Map<String,Object> paras, Class<T> target) 返回一行数据，如果有多行或者未找到，抛错
<T> T	selectUnique(String id, Object paras, Class<T> target) 返回一行数据，如果有多行或者未找到，抛错
MapperConfig	setBaseMapper(Class c)
void	setDefaultBeanProcessors(BeanProcessor defaultBeanProcessors) 设置默认的jdbc 到 bean的映射处理类，用户可以自己扩展处理最新的类型
void	setDefaultSchema(String defaultSchema) 设置对应的数据库的schema，一般不需要调用，因为通过jdbc能自动获取
void	setDs(ConnectionSource ds) 设置ConnectionSource，参考ConnectionSourceHelper
void	setEntityLoader(ClassLoader entityLoader) 设置classloder，如果没有，pojo的初始化使用ContextClassLoader或者加载Beetlsql的classLoader
void	setInters(Interceptor[] inters) 设置Interceptor
void	setMapperBuilder(MapperBuilder mapperBuilder) 设置MapperBuilder，用来生成java的dao代理类，参考getMapper
void	setNc(NameConversion nc) 设置NameConversion
void	setProcessors(Map<String,BeanProcessor> processors) 为指定的sqlId提供一个处理类，可以既可以是一个sqlId，也可以是namespace部分， 所有属于namesapce的都会被此BeanProcessor 处理
void	setSQLIdNameConversion(SQLIdNameConversion sqlIdNc) 设置sqlId到sql文件映射关系
void	setSqlLoader(SQLLoader sqlLoader)
<T> T	single(Class<T> clazz, Object pk)
<T> List<T>	template(Class<T> target, Object paras, long start, long size)
<T> List<T>	template(Class<T> target, Object paras, long start, long size, String orderBy)
<T> List<T>	template(Class<T> target, Object paras, RowMapper mapper, long start, long size)
<T> List<T>	template(Class<T> target, Object paras, String orderBy)
<T> List<T>	template(T t)
<T> List<T>	template(T t, long start, long size)
<T> List<T>	template(T t, RowMapper mapper)
<T> List<T>	template(T t, RowMapper mapper, long start, long size)
<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) 根据主键查询 获取唯一记录，如果纪录不存在，将会抛出异常
<T> T	unique(Class<T> clazz, RowMapper<T> mapper, Object pk) 根据主键查询,获取唯一记录，如果纪录不存在，将会抛出异常
int	update(String sqlId) 执行sql更新（或者删除）操作
int	update(String sqlId, Map<String,Object> paras) 执行sql更新（或者删除语句)
int	update(String sqlId, Object obj) 执行sql更新（或者删除）操作
int	updateAll(Class<?> clazz, Object param) 更新指定表
int[]	updateBatch(String sqlId, List<?> list) 对pojo批量更新执行sql更新语句，list包含的对象是作为参数，所有属性参与更新
int[]	updateBatch(String sqlId, Map<String,Object>[] maps) 批量更新
int[]	updateBatchTemplateById(Class clz, List<?> list) 批量模板更新方式，list包含的对象是作为参数，非空属性参与更新
int	updateById(Object obj) 更新一个对象
int[]	updateByIdBatch(List<?> list) 批量更新
int	updateTemplateById(Class c, Map paras)
int	updateTemplateById(Class c, Object obj) 按照模板更新
int	updateTemplateById(Object obj) 为null的值不参与更新，如果想更新null值，请使用updateById
int	upsert(Object obj) 先判断是否主键为空，如果为空，则插入，如果不为空，则从数据库 出一条，如果未取到，则插入一条，其他情况按照主键更新
protected int	upsert(Object obj, boolean template) 先判断是否主键为空，如果为空，则插入，如果不为空，则从数据库 取出一条，如果未取到，则插入一条，其他情况按照主键更新
int	upsertByTemplate(Object obj) 先判断是否主键为空，如果为空，则插入，如果不为空，则从数据库 取出一条，如果未取到，则插入一条，其他情况按照主键更新
void	useMaster(DBRunner f) 只使用master执行: sqlManager.useMaster(new DBRunner(){ public void run(SQLManager sqlManager){ sqlManager.select ..... } )
void	useSlave(DBRunner f) 只使用Slave执行: sqlManager.useSlave(new DBRunner(){ public void run(SQLManager sqlManager){ sqlManager.select ..... } )

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

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

构造器详细资料

SQLManager

public SQLManager(DBStyle dbStyle,
                  ConnectionSource ds)

创建一个beetlsql需要的sqlmanager

参数:

dbStyle -

ds -

SQLManager

public SQLManager(DBStyle dbStyle,
                  SQLLoader sqlLoader,
                  ConnectionSource ds)

参数:

dbStyle - 数据个风格

sqlLoader - sql加载

ds - 数据库连接

SQLManager

public SQLManager(DBStyle dbStyle,
                  SQLLoader sqlLoader,
                  ConnectionSource ds,
                  NameConversion nc)

参数:

dbStyle - 数据个风格

sqlLoader - sql加载

ds - 数据库连接

nc - 数据库名称与java名称转化规则

SQLManager

public SQLManager(DBStyle dbStyle,
                  SQLLoader sqlLoader,
                  ConnectionSource ds,
                  NameConversion nc,
                  Interceptor[] inters)

参数:

dbStyle -

sqlLoader -

ds -

nc -

inters -

SQLManager

public SQLManager(DBStyle dbStyle,
                  SQLLoader sqlLoader,
                  ConnectionSource ds,
                  NameConversion nc,
                  Interceptor[] inters,
                  String defaultSchema)

参数:

dbStyle -

sqlLoader -

ds -

nc -

inters -

defaultSchema - 数据库访问的schema，为null自动判断

SQLManager

public SQLManager(DBStyle dbStyle,
                  SQLLoader sqlLoader,
                  ConnectionSource ds,
                  NameConversion nc,
                  Interceptor[] inters,
                  String defaultSchema,
                  Properties ps)

SQLManager

public SQLManager(DBStyle dbStyle,
                  SQLLoader sqlLoader,
                  ConnectionSource ds,
                  NameConversion nc,
                  Interceptor[] inters,
                  String defaultSchema,
                  Properties ps,
                  String name)

参数:

dbStyle -

sqlLoader -

ds -

nc -

inters -

defaultSchema -

ps - 额外的beetl配置

方法详细资料

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构建器

getSQLManagerByName

public static SQLManager getSQLManagerByName(String name)

每个sqlManager都有个名称，如果未指定，默认是dbStyle 返回的名称，即数据库名

参数:

name -

返回:

query

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

lambdaQuery

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

isOffsetStartZero

public boolean isOffsetStartZero()

isProductMode

public boolean isProductMode()

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

返回:

getSQLResult

public SQLResult getSQLResult(String id,
                              Map<String,Object> paras)

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

参数:

id -

paras -

返回:

getSQLResult

public SQLResult getSQLResult(String id,
                              Object paras)

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

参数:

id -

paras -

返回:

getSQLMetadata

public void getSQLMetadata(String id,
                           Object paras)

getSQLResult

public SQLResult getSQLResult(SQLSource source,
                              Map inputParas)

内部使用，

参数:

source -

inputParas -

返回:

getSQLResult

public SQLResult getSQLResult(String id,
                              Map<String,Object> paras,
                              org.beetl.core.Context ctx)

getScript

public SQLScript getScript(String id)

得到指定sqlId的sqlscript对象

参数:

id -

返回:

getScript

public SQLScript getScript(Class<?> cls,
                           ConstantEnum constantEnum)

得到增删改查模板

参数:

cls - clz

constantEnum - ConstantEnum

返回:

SQLScript

getPageSqlScript

public SQLScript getPageSqlScript(String selectId)

获取为分页语句

参数:

selectId -

返回:

select

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

通过sqlId进行查询,查询结果映射到clazz上

参数:

sqlId - sql标记

clazz - 需要映射的Pojo类,可以是实体类，也可以是一个Map

paras - 参数集合

返回:

Pojo集合

select

public <T> List<T> select(String sqlId,
                          Class<T> clazz,
                          Map<String,Object> paras,
                          RowMapper<T> mapper)

通过sqlId进行查询,查询结果映射到clazz上，mapper类可以定制映射

参数:

sqlId - sql标记

clazz - 需要映射的Pojo类,可以是实体类，也可以是一个Map

paras - 参数集合

mapper - 自定义结果映射方式

返回:

select

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

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

参数:

sqlId - sql标记

clazz - 需要映射的Pojo类

paras - Bean

返回:

Pojo集合

select

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

根据sqlId查询目标对象

参数:

sqlId -

clazz -

返回:

select

public <T> List<T> select(String sqlId,
                          Class<T> clazz,
                          Object paras,
                          RowMapper<T> mapper)

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

参数:

sqlId - sql标记

clazz - 需要映射的Pojo类

paras - Bean

mapper - 自定义结果映射方式

返回:

select

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

翻页查询

参数:

sqlId - sql标记

clazz - 需要映射的Pojo类

paras - Bean

start - 开始位置

size - 查询条数

返回:

select

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

翻页查询

参数:

sqlId - sql标记

clazz - 需要映射的Pojo类

paras - Bean

mapper - 自定义结果映射方式

start - 开始位置

size - 查询条数

返回:

Pojo集合

select

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

翻页查询

参数:

sqlId - sql标记

clazz - 需要映射的Pojo类

paras - 条件集合

start - 开始位置

size - 查询条数

返回:

select

public <T> List<T> select(String sqlId,
                          Class<T> clazz,
                          Map<String,Object> paras,
                          RowMapper<T> mapper,
                          long start,
                          long size)

翻页查询

参数:

sqlId - sql标记

clazz - 需要映射的Pojo类

paras - 条件集合

mapper - 自定义结果映射方式

start - 开始位置

size - 查询条数

返回:

pageQuery

public <T> PageQuery<T> pageQuery(String sqlId,
                                  Class<T> clazz,
                                  PageQuery<T> query)

pageQuery

public <T> PageQuery<T> pageQuery(String sqlId,
                                  Class<T> clazz,
                                  PageQuery query,
                                  RowMapper<T> mapper)

翻页查询，假设有sqlId和sqlId$count 俩个sql存在，beetlsql会通过 这俩个sql来查询总数以及翻页操作，如果没有sqlId$count，则假设sqlId 包含了page函数或者标签 ，如

 queryUser
 ===
 select #page("a.*,b.name")# from user a left join role b ....
 

参数:

sqlId -

clazz -

query -

mapper -

返回:

unique

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

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

参数:

clazz -

pk - 主键

返回:

unique

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

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

参数:

clazz -

mapper - 自定义结果映射方式

pk - 主键

返回:

single

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

参数:

clazz -

pk -

返回:

如果没有找到，返回null

lock

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

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

参数:

clazz -

pk -

返回:

all

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

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

参数:

clazz -

返回:

all

public <T> List<T> all(Class<T> clazz,
                       long start,
                       long size)

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

参数:

clazz -

start -

size -

返回:

allCount

public long allCount(Class<?> clazz)

查询记录数

参数:

clazz -

返回:

all

public <T> List<T> all(Class<T> clazz,
                       RowMapper<T> mapper,
                       long start,
                       int end)

查询所有记录

参数:

clazz -

mapper -

start -

end -

返回:

all

public <T> List<T> all(Class<T> clazz,
                       RowMapper<T> mapper)

查询所有记录

参数:

clazz -

mapper -

返回:

template

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

templateOne

public <T> T templateOne(T t)

template

public <T> List<T> template(T t,
                            RowMapper mapper)

template

public <T> List<T> template(T t,
                            long start,
                            long size)

template

public <T> List<T> template(Class<T> target,
                            Object paras,
                            long start,
                            long size)

template

public <T> List<T> template(T t,
                            RowMapper mapper,
                            long start,
                            long size)

template

public <T> List<T> template(Class<T> target,
                            Object paras,
                            RowMapper mapper,
                            long start,
                            long size)

template

public <T> List<T> template(Class<T> target,
                            Object paras,
                            String orderBy)

template

public <T> List<T> template(Class<T> target,
                            Object paras,
                            long start,
                            long size,
                            String orderBy)

templateCount

public <T> long templateCount(T t)

查询总数

参数:

t -

返回:

templateCount

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

longValue

public Long longValue(String id,
                      Map<String,Object> paras)

将查询结果返回成Long类型

参数:

id -

paras -

返回:

longValue

public Long longValue(String id,
                      Object paras)

将查询结果返回成Long类型

参数:

id -

paras -

返回:

intValue

public Integer intValue(String id,
                        Object paras)

将查询结果返回成Integer类型

参数:

id -

paras -

返回:

intValue

public Integer intValue(String id,
                        Map<String,Object> paras)

将查询结果返回成Integer类型

参数:

id -

paras -

返回:

bigDecimalValue

public BigDecimal bigDecimalValue(String id,
                                  Object paras)

将查询结果返回成BigDecimal类型

参数:

id -

paras -

返回:

bigDecimalValue

public BigDecimal bigDecimalValue(String id,
                                  Map<String,Object> paras)

将查询结果返回成BigDecimal类型

参数:

id -

paras -

返回:

selectSingle

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

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

参数:

sqlId -

paras -

target -

返回:

selectSingle

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

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

参数:

sqlId -

paras -

target -

返回:

selectUnique

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

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

参数:

id -

paras -

target -

返回:

selectUnique

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

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

参数:

id -

paras -

target -

返回:

deleteById

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

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

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

参数:

clazz -

pkValue -

返回:

deleteObject

public int deleteObject(Object obj)

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

参数:

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

返回:

insert

public int insert(Object paras)

通用插入操作

参数:

paras -

返回:

insert

public int insert(Object paras,
                  boolean autoDbAssignKey)

插入实体

参数:

paras -

autoDbAssignKey - 是否自动从数据库获取主键值, 自增或者序列

返回:

insertTemplate

public int insertTemplate(Object paras)

通用模板插入

参数:

paras -

返回:

insertTemplate

public int insertTemplate(Object paras,
                          boolean autoDbAssignKey)

模板插入，并根据autoAssignKey 自动获取自增主键值

参数:

paras -

autoDbAssignKey -

返回:

insert

public int insert(Class clazz,
                  Object paras,
                  boolean autoDbAssignKey)

对于有自增主键的表，插入一行记录

参数:

clazz -

paras -

autoDbAssignKey，是否获取自增主键 -

返回:

insertTemplate

public int insertTemplate(Class clazz,
                          Object paras,
                          boolean autoDbAssignKey)

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

参数:

clazz -

paras -

autoDbAssignKey -

返回:

insert

public int insert(Class<?> clazz,
                  Object paras)

插入对象通用的方法，如果数据表有自增主键，需要获取到自增主键，参考使用 insert(Object paras,boolean autoAssignKey)，或者使用 带有KeyHolder的方法

参数:

clazz -

paras -

返回:

exist

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

是否有此对象

参数:

clazz -

pk - 主健

返回:

assignAutoId

protected void assignAutoId(Object bean,
                            Object id)

insertBatch

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

批量插入

参数:

clazz -

list -

insertBatch

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

insert

public int insert(Class<?> clazz,
                  Object paras,
                  KeyHolder holder)

插入，并获取自增主键的值

参数:

clazz -

paras -

holder - 自增或者序列主健放到holder对象里

insertTemplate

public int insertTemplate(Class<?> clazz,
                          Object paras,
                          KeyHolder holder)

模板插入，仅仅插入非空属性，并获取自增主键

参数:

clazz -

paras -

holder -

返回:

insert

public int insert(String sqlId,
                  Object paras,
                  KeyHolder holder,
                  String keyName)

插入，并获取主键

参数:

sqlId -

paras - 参数

holder -

keyName - 主键列名称

insert

public int insert(String sqlId,
                  Object paras,
                  KeyHolder holder)

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

参数:

sqlId -

paras -

holder -

返回:

insert

public int insert(String sqlId,
                  Class<?> clazz,
                  Map paras,
                  KeyHolder holder)

插入操作，数据库自增主键放到keyHolder里

参数:

sqlId -

clazz -

paras -

holder -

返回:

insert

public int insert(String sqlId,
                  Map paras,
                  KeyHolder holder,
                  String keyName)

插入，并获取自增主键值，因为此接口并未指定实体对象，因此需要keyName来指明数据库主键列

参数:

sqlId -

paras -

holder -

keyName - 主键列名称

upsert

public int upsert(Object obj)

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

参数:

obj -

返回:

受影响条数

upsertByTemplate

public int upsertByTemplate(Object obj)

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

参数:

obj -

返回:

受影响条数

upsert

protected int upsert(Object obj,
                     boolean template)

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

参数:

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

template -

返回:

受影响条数

updateById

public int updateById(Object obj)

更新一个对象

参数:

obj -

返回:

updateTemplateById

public int updateTemplateById(Object obj)

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

参数:

obj -

返回:

返回更新的条数

updateTemplateById

public int updateTemplateById(Class c,
                              Map paras)

参数:

c - c对应的表名

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

返回:

返回更新的条数

updateTemplateById

public int updateTemplateById(Class c,
                              Object obj)

按照模板更新

参数:

c -

obj -

返回:

updateByIdBatch

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

批量更新

参数:

list - ,包含pojo（不支持map）

返回:

update

public int update(String sqlId,
                  Object obj)

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

参数:

sqlId -

obj -

返回:

返回更新的条数

update

public int update(String sqlId)

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

参数:

sqlId -

返回:

返回更新的条数

update

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

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

参数:

sqlId -

paras -

返回:

返回更新的条数

updateBatch

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

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

参数:

sqlId -

list -

返回:

返回更新的条数

updateBatchTemplateById

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

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

参数:

clz -

list -

返回:

updateBatch

public int[] updateBatch(String sqlId,
                         Map<String,Object>[] maps)

批量更新

参数:

sqlId -

maps - 参数放在map里

返回:

updateAll

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

更新指定表

参数:

clazz -

param - 参数

返回:

useMaster

public void useMaster(DBRunner f)

只使用master执行:

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

参数:

f -

useSlave

public void useSlave(DBRunner f)

只使用Slave执行:

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

参数:

f -

execute

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

直接执行语句,sql是模板

参数:

sqlTemplate -

clazz -

paras -

返回:

execute

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

直接执行sql查询语句，sql是模板

参数:

sqlTemplate -

clazz -

paras -

返回:

execute

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

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

参数:

sqlTemplate -

clazz -

paras -

start -

size -

返回:

execute

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

直接执行sql模板查询，并获取指定范围的结果集

参数:

sqlTemplate -

clazz -

paras -

start -

size -

返回:

executePageQuery

public <T> PageQuery<T> executePageQuery(String sqlTemplate,
                                         Class<T> clazz,
                                         PageQuery<T> pageQuery)

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

参数:

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

clazz -

pageQuery -

返回:

executeUpdate

public int executeUpdate(String sqlTemplate,
                         Object paras)

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

参数:

sqlTemplate -

paras -

返回:

executeUpdate

public int executeUpdate(String sqlTemplate,
                         Map paras)

直接更新sql，sql是模板

参数:

sqlTemplate -

paras -

返回:

execute

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

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

参数:

clazz -

p -

返回:

返回查询结果

execute

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

executeUpdate

public int executeUpdate(SQLReady p)

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

参数:

p -

返回:

返回更新条数

executeBatchUpdate

public int[] executeBatchUpdate(SQLBatchReady batch)

executeOnConnection

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

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

参数:

onConnection -

返回:

genPojoCode

public void genPojoCode(String table,
                        String pkg,
                        String srcPath,
                        GenConfig config)
                 throws Exception

根据表名生成对应的pojo类

参数:

table - 表名

pkg - 包名,如 com.test

srcPath: - 文件保存路径

config - 配置生成的风格

抛出:

Exception

genPojoCode

public void genPojoCode(String table,
                        String pkg,
                        GenConfig config)
                 throws Exception

同上，但路径自动根据项目当前目录推测，是src目录下，或者src/main/java 下

参数:

table -

pkg -

config -

抛出:

Exception

genPojoCode

public void genPojoCode(String table,
                        String pkg)
                 throws Exception

生成pojo类,默认路径是当前工程src目录,或者是src/main/java 下

参数:

table -

pkg -

抛出:

Exception

genPojoCodeToConsole

public void genPojoCodeToConsole(String table,
                                 String pkg)
                          throws Exception

仅仅打印pojo类到控制台

参数:

table -

pkg - 包名

抛出:

Exception

genPojoCodeToConsole

public void genPojoCodeToConsole(String table)
                          throws Exception

仅仅打印pojo类到控制台，使用默认的包,建议使用genPojoCodeToConsole(String table,String pkg)

参数:

table -

抛出:

Exception

genPojoCodeToConsole

public void genPojoCodeToConsole(String table,
                                 GenConfig config)
                          throws Exception

仅仅打印pojo类到控制台

参数:

table -

抛出:

Exception

genSQLFile

public void genSQLFile(String table,
                       GenConfig config)
                throws Exception

将sql模板文件输出到src下，如果采用的是ClasspathLoader，则使用ClasspathLoader的配置，否则， 生成到src的sql代码里

参数:

table -

抛出:

Exception

genSQLFile

public void genSQLFile(String table,
                       String alias,
                       GenConfig config)
                throws Exception

抛出:

Exception

genSQLTemplateToConsole

public void genSQLTemplateToConsole(String table)
                             throws Exception

生成sql语句片段,包含了条件查询，列名列表，更新，插入等语句

参数:

table -

抛出:

Exception

genSQLTemplateToConsole

public void genSQLTemplateToConsole(String table,
                                    String alias)
                             throws Exception

生成md到控制台，使用别名

参数:

table -

alias -

抛出:

Exception

genALL

public void genALL(String pkg,
                   GenConfig config,
                   GenFilter filter)
            throws Exception

生成数据库的所有entity，dao，还有md文件，

参数:

pkg -

config -

filter - 最好设置filter以避免覆盖已有代码

抛出:

Exception

genBuiltInSqlToConsole

public void genBuiltInSqlToConsole(Class cls)

生成内置的sql，插入，更新，主键查找，删除语句

参数:

cls -

getMapper

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

通过mapper接口生成dao代理

参数:

mapperInterface -

返回:

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的数据库类型

返回:

getBeetl

public Beetl getBeetl()

得到beetl引擎

返回:

getMetaDataManager

public MetadataManager getMetaDataManager()

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

返回:

getDefaultSchema

public String getDefaultSchema()

setDefaultSchema

public void setDefaultSchema(String defaultSchema)

设置对应的数据库的schema，一般不需要调用，因为通过jdbc能自动获取

参数:

defaultSchema -

getMapperBuilder

public MapperBuilder getMapperBuilder()

得到MapperBuilder,默认是DefaultMapperBuilder

返回:

setMapperBuilder

public void setMapperBuilder(MapperBuilder mapperBuilder)

设置MapperBuilder，用来生成java的dao代理类，参考getMapper

参数:

mapperBuilder -

getInters

public Interceptor[] getInters()

得到所有的Interceptor

返回:

setInters

public void setInters(Interceptor[] inters)

设置Interceptor

参数:

inters -

addIdAutonGen

public void addIdAutonGen(String name,
                          IDAutoGen alorithm)

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

参数:

name -

alorithm -

getAssignIdByIdAutonGen

protected Object getAssignIdByIdAutonGen(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 -

setSQLIdNameConversion

public void setSQLIdNameConversion(SQLIdNameConversion sqlIdNc)

设置sqlId到sql文件映射关系

参数:

sqlIdNc -

getSQLIdNameConversion

public SQLIdNameConversion getSQLIdNameConversion()

getMapperConfig

public MapperConfig getMapperConfig()

setBaseMapper

public MapperConfig setBaseMapper(Class c)

参数:

c - 设置一个基接口, 也是推荐的编程方式, 这样可以与框架解耦

getSQLManagerName

public String getSQLManagerName()

refresh

public void refresh()

清空缓存，用于动态增加修改表情况下可以

isRefreshReady

public boolean isRefreshReady()

getEntityLoader

public ClassLoader getEntityLoader()

setEntityLoader

public void setEntityLoader(ClassLoader entityLoader)

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

参数:

entityLoader -

addVirtualTable

public void addVirtualTable(String realTable,
                            String virtualTable)

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

参数:

virtualTable -

realTable -