com.litongjava.db.activerecord

类 DbPro

java.lang.Object

com.litongjava.db.activerecord.DbPro

直接已知子类:

BatchSaveFetchGeneratedKey

public class DbPro
extends Object

DbPro. Professional database query and update tool.

字段概要

字段

限定符和类型	字段和说明
protected Config	config

构造器概要

构造器

构造器和说明
DbPro()
DbPro(String configName)

方法概要

限定符和类型	方法和说明
protected int[]	batch(Config config, Connection conn, List<String> sqlList, int batchSize)
protected int[]	batch(Config config, Connection conn, String sql, Object[][] paras, int batchSize)
protected int[]	batch(Config config, Connection conn, String sql, String columns, List list, int batchSize)
int[]	batch(List<String> sqlList, int batchSize) Execute a batch of SQL INSERT, UPDATE, or DELETE queries.
int[]	batch(String sql, Object[][] paras, int batchSize) Execute a batch of SQL INSERT, UPDATE, or DELETE queries.
int[]	batch(String sql, String columns, List modelOrRecordList, int batchSize) Execute a batch of SQL INSERT, UPDATE, or DELETE queries.
int[]	batchDelete(String tableName, List<? extends Record> recordList, int batchSize)
int[]	batchSave(List<? extends Model> modelList, int batchSize) Batch save models using the "insert into ..." sql generated by the first model in modelList.
int[]	batchSave(String tableName, List<? extends Record> recordList, int batchSize) Batch save records using the "insert into ..." sql generated by the first record in recordList.
int[]	batchUpdate(List<? extends Model> modelList, int batchSize) Batch update models using the attrs names of the first model in modelList.
int[]	batchUpdate(String tableName, List<? extends Record> recordList, int batchSize) Batch update records with default primary key, using the columns names of the first record in recordList.
int[]	batchUpdate(String tableName, String primaryKey, List<? extends Record> recordList, int batchSize) Batch update records using the columns names of the first record in recordList.
Long	count(String sql)
Long	countTable(String table)
int	delete(String sql)
int	delete(String sql, Object... paras) Execute delete sql statement.
boolean	delete(String tableName, Record record) Example: String noteId="0000000"; Record removeRecordFilter = new Record(); removeRecordFilter.set("note_id", noteId); Db.delete(ENoteTableNames.ENOTE_NOTE_TAG, removeRecordFilter);
boolean	delete(String tableName, String primaryKey, Record record) Delete record.
boolean	deleteById(String tableName, Object idValue) Delete record by id with default primary key.
boolean	deleteById(String tableName, String primaryKey, Object idValue)
boolean	deleteByIds(String tableName, Record record) Example: boolean succeed = Db.use().delete("user", user);
boolean	deleteByIds(String tableName, String primaryKey, Object... idValues) Delete record by ids.
<T> Page<T>	doPaginate(Class<T> clazz, int pageNumber, int pageSize, Boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras)
protected Page<Record>	doPaginate(int pageNumber, int pageSize, Boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras)
<T> Page<T>	doPaginateByCache(Class<T> clazz, String cacheName, Object key, int pageNumber, int pageSize, Boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras)
Page<Record>	doPaginateByCache(String cacheName, Object key, int pageNumber, int pageSize, Boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras)
<T> Page<T>	doPaginateByFullSql(Class<T> clazz, Config config2, Connection conn, int pageNumber, int pageSize, Boolean isGroupBySql, String totalRowSql, StringBuilder findSql, Object[] paras)
protected <T> Page<T>	doPaginateByFullSql(Class<T> clazz, int pageNumber, int pageSize, Boolean isGroupBySql, String totalRowSql, String findSql, Object... paras)
protected Page<Record>	doPaginateByFullSql(Config config, Connection conn, int pageNumber, int pageSize, Boolean isGroupBySql, String totalRowSql, StringBuilder findSql, Object... paras)
protected Page<Record>	doPaginateByFullSql(int pageNumber, int pageSize, Boolean isGroupBySql, String totalRowSql, String findSql, Object... paras)
protected Page<Record>	doPaginateByFullSqlWithJsonFields(Config config, Connection conn, int pageNumber, int pageSize, Boolean isGroupBySql, String totalRowSql, StringBuilder findSql, String[] jsonFields, Object... paras)
protected Page<Record>	doPaginateJsonFields(int pageNumber, int pageSize, Boolean isGroupBySql, String select, String sqlExceptSelect, String[] jsonFields, Object... paras)
void	each(java.util.function.Function<Record,Boolean> func, String sql, Object... paras) 迭代处理每一个查询出来的 Record 对象 例子： Db.each(record -> { // 处理 record 的代码在此 // 返回 true 继续循环处理下一条数据，返回 false 立即终止循环 return true; }, sql, paras);
protected Object	execute(Config config, ICallback callback) Execute callback.
Object	execute(ICallback callback)
boolean	exists(String sql, Object[] paras)
boolean	exists(String tableName, String fields, Object... paras)
protected <T> List<T>	find(Class<T> clazz, Config config, Connection conn, String sql, Object... paras)
<T> List<T>	find(Class<T> clazz, SqlPara sqlPara)
<T> List<T>	find(Class<T> clazz, String sql, Object... paras)
protected List<Record>	find(Config config, Connection conn, String sql, Object... paras)
List<Record>	find(SqlPara sqlPara)
List<Record>	find(String sql)
List<Record>	find(String sql, Object... paras)
<T> List<T>	findAll(Class<T> clazz, String tableName)
List<Record>	findAll(String tableName)
<T> List<T>	findByCache(Class<T> clazz, String cacheName, Object key, String sql)
<T> List<T>	findByCache(Class<T> clazz, String cacheName, Object key, String sql, Object... paras)
List<Record>	findByCache(String cacheName, Object key, String sql)
List<Record>	findByCache(String cacheName, Object key, String sql, Object... paras) Find Record by cache.
List<Record>	findByColumn(String tableName, String column, String value)
<T> T	findById(Class<T> clazz, String tableName, Object idValue)
<T> T	findById(Class<T> clazz, String tableName, String primaryKey, Object idValue)
Record	findById(String tableName, Object idValue) Find record by id with default primary key.
Record	findById(String tableName, String primaryKey, Object idValue)
<T> T	findByIds(Class<T> clazz, String tableName, String primaryKey, Object... idValues)
Record	findByIds(String tableName, String primaryKey, Object... idValues) Find record by ids.
List<Record>	findColumns(String tableName, String columns, String primaryKey, Object... idValues)
<T> List<T>	findColumnsAll(Class<T> clazz, String tableName, String columns)
List<Record>	findColumnsAll(String tableName, String columns)
<T> T	findColumnsById(Class<T> clazz, String tableName, String columns, Object idValue)
<T> T	findColumnsById(Class<T> clazz, String tableName, String columns, String primaryKey, Object... idValues)
Record	findColumnsById(String tableName, String columns, Object idValue)
Record	findColumnsById(String tableName, String columns, String primaryKey, Object... idValues)
<T> T	findColumnsByIds(Class<T> clazz, String tableName, String columns, String primaryKey, Object... idValues)
Record	findColumnsByIds(String tableName, String columns, String primaryKey, Object... idValues)
<T> T	findFirst(Class<T> clazz, SqlPara sqlPara)
<T> T	findFirst(Class<T> clazz, String sql, Object... paras)
Record	findFirst(SqlPara sqlPara)
Record	findFirst(String sql)
Record	findFirst(String sql, Object... paras) Find first record.
<T> T	findFirstByCache(Class<T> clazz, String cacheName, Object key, String sql)
<T> T	findFirstByCache(Class<T> clazz, String cacheName, Object key, String sql, Object... paras)
Record	findFirstByCache(String cacheName, Object key, String sql)
Record	findFirstByCache(String cacheName, Object key, String sql, Object... paras) Find first record by cache.
Record	findFirstJsonField(String sql, String[] jsonFields, Object... paras)
protected List<Record>	findJsonField(Config config, Connection conn, String sql, String[] jsonFields, Object... paras)
List<Record>	findJsonField(String sql, String[] jsonFields, Object... paras)
List<Record>	findWithJsonField(String sql, String[] jsonFields, Object... paras)
List<Record>	findWithJsonFields(String sql, String[] jsonFields)
List<Record>	findWithPrimaryKey(String tableName, String primaryKey, Object... idValues)
Config	getConfig()
String	getSql(String key)
SqlPara	getSqlPara(String key, Map data)
SqlPara	getSqlPara(String key, Model model)
SqlPara	getSqlPara(String key, Object... paras)
SqlPara	getSqlPara(String key, Record record)
SqlPara	getSqlParaByString(String content, Map data)
SqlPara	getSqlParaByString(String content, Object... paras)
<T> Page<T>	paginate(Class<T> clazz, int pageNumber, int pageSize, boolean isGroupBySql, SqlPara sqlPara)
<T> Page<T>	paginate(Class<T> clazz, int pageNumber, int pageSize, boolean isGroupBySql, String select, String sqlExceptSelect)
<T> Page<T>	paginate(Class<T> clazz, int pageNumber, int pageSize, boolean isGroupBySql, String select, String sqlExceptSelect, Object[] paras)
<T> Page<T>	paginate(Class<T> clazz, int pageNumber, int pageSize, SqlPara sqlPara)
<T> Page<T>	paginate(Class<T> clazz, int pageNumber, int pageSize, String select, String sqlExceptSelect)
<T> Page<T>	paginate(Class<T> clazz, int pageNumber, int pageSize, String select, String sqlExceptSelect, Object[] paras)
protected Page<Record>	paginate(Config config, Connection conn, int pageNumber, int pageSize, String select, String sqlExceptSelect, Object... paras)
Page<Record>	paginate(int pageNumber, int pageSize, boolean isGroupBySql, SqlPara sqlPara)
Page<Record>	paginate(int pageNumber, int pageSize, boolean isGroupBySql, String select, String sqlExceptSelect)
Page<Record>	paginate(int pageNumber, int pageSize, boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras)
Page<Record>	paginate(int pageNumber, int pageSize, SqlPara sqlPara)
Page<Record>	paginate(int pageNumber, int pageSize, String select, String sqlExceptSelect)
Page<Record>	paginate(int pageNumber, int pageSize, String select, String sqlExceptSelect, Object... paras) Paginate.
<T> Page<T>	paginateByCache(Class<T> clazz, String cacheName, Object key, int pageNumber, int pageSize, boolean isGroupBySql, SqlPara sqlPara)
<T> Page<T>	paginateByCache(Class<T> clazz, String cacheName, Object key, int pageNumber, int pageSize, boolean isGroupBySql, String select, String sqlExceptSelect)
<T> Page<T>	paginateByCache(Class<T> clazz, String cacheName, Object key, int pageNumber, int pageSize, boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras)
<T> Page<T>	paginateByCache(Class<T> clazz, String cacheName, Object key, int pageNumber, int pageSize, SqlPara sqlPara)
<T> Page<T>	paginateByCache(Class<T> clazz, String cacheName, Object key, int pageNumber, int pageSize, String select, String sqlExceptSelect)
<T> Page<T>	paginateByCache(Class<T> clazz, String cacheName, Object key, int pageNumber, int pageSize, String select, String sqlExceptSelect, Object... paras)
Page<Record>	paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, boolean isGroupBySql, SqlPara sqlPara)
Page<Record>	paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, boolean isGroupBySql, String select, String sqlExceptSelect)
Page<Record>	paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras)
Page<Record>	paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, SqlPara sqlPara)
Page<Record>	paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, String select, String sqlExceptSelect)
Page<Record>	paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, String select, String sqlExceptSelect, Object... paras) Paginate by cache.
<T> Page<T>	paginateByCacheByFullSql(Class<T> clazz, String cacheName, Object key, int pageNumber, int pageSize, boolean isGroupBySql, String totalRowSql, String findSql, Object... paras)
<T> Page<T>	paginateByCacheByFullSql(Class<T> clazz, String cacheName, Object key, int pageNumber, int pageSize, String totalRowSql, String findSql, Object... paras)
Page<Record>	paginateByCacheByFullSql(String cacheName, Object key, int pageNumber, int pageSize, boolean isGroupBySql, String totalRowSql, String findSql, Object... paras)
Page<Record>	paginateByCacheByFullSql(String cacheName, Object key, int pageNumber, int pageSize, String totalRowSql, String findSql, Object... paras)
<T> Page<T>	paginateByFullSql(Class<T> clazz, int pageNumber, int pageSize, boolean isGroupBySql, String totalRowSql, String findSql, Object... paras)
<T> Page<T>	paginateByFullSql(Class<T> clazz, int pageNumber, int pageSize, String totalRowSql, String findSql, Object... paras)
Page<Record>	paginateByFullSql(int pageNumber, int pageSize, boolean isGroupBySql, String totalRowSql, String findSql, Object... paras)
Page<Record>	paginateByFullSql(int pageNumber, int pageSize, String totalRowSql, String findSql, Object... paras)
Page<Record>	paginateJsonFields(int pageNumber, int pageSize, String select, String sqlExceptSelect, String[] jsonFields)
Page<Record>	paginateJsonFields(int pageNumber, int pageSize, String select, String sqlExceptSelect, String[] jsonFields, Object... paras)
protected <T> List<T>	query(Config config, Connection conn, String sql, Object... paras)
<T> List<T>	query(String sql)
<T> List<T>	query(String sql, Object... paras)
BigDecimal	queryBigDecimal(String sql)
BigDecimal	queryBigDecimal(String sql, Object... paras)
BigInteger	queryBigInteger(String sql)
BigInteger	queryBigInteger(String sql, Object... paras)
Boolean	queryBoolean(String sql)
Boolean	queryBoolean(String sql, Object... paras)
Byte	queryByte(String sql)
Byte	queryByte(String sql, Object... paras)
byte[]	queryBytes(String sql)
byte[]	queryBytes(String sql, Object... paras)
<T> T	queryColumn(String sql, Object... paras) Execute sql query just return one column.
Date	queryDate(String sql)
Date	queryDate(String sql, Object... paras)
Double	queryDouble(String sql)
Double	queryDouble(String sql, Object... paras)
<T> T	queryFirst(String sql)
<T> T	queryFirst(String sql, Object... paras) Execute sql query and return the first result.
Float	queryFloat(String sql)
Float	queryFloat(String sql, Object... paras)
Integer	queryInt(String sql)
Integer	queryInt(String sql, Object... paras)
java.time.LocalDateTime	queryLocalDateTime(String sql)
java.time.LocalDateTime	queryLocalDateTime(String sql, Object... paras)
Long	queryLong(String sql)
Long	queryLong(String sql, Object... paras)
Number	queryNumber(String sql)
Number	queryNumber(String sql, Object... paras)
Short	queryShort(String sql)
Short	queryShort(String sql, Object... paras)
String	queryStr(String sql)
String	queryStr(String sql, Object... paras)
Time	queryTime(String sql)
Time	queryTime(String sql, Object... paras)
Timestamp	queryTimestamp(String sql)
Timestamp	queryTimestamp(String sql, Object... paras)
protected boolean	save(Config config, Connection conn, String tableName, String primaryKey, Record record)
protected boolean	save(Config config, Connection conn, String tableName, String primaryKey, Record record, String[] jsonFields)
boolean	save(String tableName, Record record)
boolean	save(String tableName, Record record, String[] jsonFields)
boolean	save(String tableName, String primaryKey, Record record) Save record.
boolean	save(String tableName, String primaryKey, Record record, String[] jsonFields)
DbTemplate	template(String key, Map data)
DbTemplate	template(String key, Object... paras)
DbTemplate	templateByString(String content, Map data)
DbTemplate	templateByString(String content, Object... paras)
protected boolean	tx(Config config, int transactionLevel, IAtom atom) Execute transaction.
boolean	tx(IAtom atom) Execute transaction with default transaction level.
boolean	tx(int transactionLevel, IAtom atom)
Future<Boolean>	txInNewThread(IAtom atom) 主要用于嵌套事务场景 实例：https://jfinal.com/feedback/4008 默认情况下嵌套事务会被合并成为一个事务，那么内层与外层任何地方回滚事务 所有嵌套层都将回滚事务，也就是说嵌套事务无法独立提交与回滚 使用 txInNewThread(...)
Future<Boolean>	txInNewThread(int transactionLevel, IAtom atom)
protected int	update(Config config, Connection conn, String sql, Object... paras) Execute sql update
protected boolean	update(Config config, Connection conn, String tableName, String primaryKey, Record record)
protected boolean	update(Config config, Connection conn, String tableName, String primaryKey, Record record, String[] jsonFields)
int	update(SqlPara sqlPara)
int	update(String sql)
int	update(String sql, Object... paras) Execute update, insert or delete sql statement.
boolean	update(String tableName, Record record) Update record with default primary key.
boolean	update(String tableName, String primaryKey, Record record) Update Record.
boolean	update(String tableName, String primaryKey, Record record, String[] jsonFields)

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

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

字段详细资料

config

protected final Config config

构造器详细资料

DbPro

public DbPro()

DbPro

public DbPro(String configName)

方法详细资料

getConfig

public Config getConfig()

query

protected <T> List<T> query(Config config,
                            Connection conn,
                            String sql,
                            Object... paras)

query

public <T> List<T> query(String sql,
                         Object... paras)

query

public <T> List<T> query(String sql)

参数:

sql - an SQL statement

另请参阅:

query(String, Object...)

queryFirst

public <T> T queryFirst(String sql,
                        Object... paras)

Execute sql query and return the first result. I recommend add "limit 1" in your sql.

参数:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

paras - the parameters of sql

返回:

Object[] if your sql has select more than one column, and it return Object if your sql has select only one column.

queryFirst

public <T> T queryFirst(String sql)

参数:

sql - an SQL statement

另请参阅:

queryFirst(String, Object...)

queryColumn

public <T> T queryColumn(String sql,
                         Object... paras)

Execute sql query just return one column.

类型参数:

T - the type of the column that in your sql's select statement

参数:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

paras - the parameters of sql

返回:

T

queryStr

public String queryStr(String sql,
                       Object... paras)

queryStr

public String queryStr(String sql)

queryInt

public Integer queryInt(String sql,
                        Object... paras)

queryInt

public Integer queryInt(String sql)

queryLong

public Long queryLong(String sql,
                      Object... paras)

queryLong

public Long queryLong(String sql)

queryDouble

public Double queryDouble(String sql,
                          Object... paras)

queryDouble

public Double queryDouble(String sql)

queryFloat

public Float queryFloat(String sql,
                        Object... paras)

queryFloat

public Float queryFloat(String sql)

queryBigDecimal

public BigDecimal queryBigDecimal(String sql,
                                  Object... paras)

queryBigDecimal

public BigDecimal queryBigDecimal(String sql)

queryBigInteger

public BigInteger queryBigInteger(String sql,
                                  Object... paras)

queryBigInteger

public BigInteger queryBigInteger(String sql)

queryBytes

public byte[] queryBytes(String sql,
                         Object... paras)

queryBytes

public byte[] queryBytes(String sql)

queryDate

public Date queryDate(String sql,
                      Object... paras)

queryDate

public Date queryDate(String sql)

queryLocalDateTime

public java.time.LocalDateTime queryLocalDateTime(String sql,
                                                  Object... paras)

queryLocalDateTime

public java.time.LocalDateTime queryLocalDateTime(String sql)

queryTime

public Time queryTime(String sql,
                      Object... paras)

queryTime

public Time queryTime(String sql)

queryTimestamp

public Timestamp queryTimestamp(String sql,
                                Object... paras)

queryTimestamp

public Timestamp queryTimestamp(String sql)

queryBoolean

public Boolean queryBoolean(String sql,
                            Object... paras)

queryBoolean

public Boolean queryBoolean(String sql)

queryShort

public Short queryShort(String sql,
                        Object... paras)

queryShort

public Short queryShort(String sql)

queryByte

public Byte queryByte(String sql,
                      Object... paras)

queryByte

public Byte queryByte(String sql)

queryNumber

public Number queryNumber(String sql,
                          Object... paras)

queryNumber

public Number queryNumber(String sql)

update

protected int update(Config config,
                     Connection conn,
                     String sql,
                     Object... paras)
              throws SQLException

Execute sql update

抛出:

SQLException

update

public int update(String sql,
                  Object... paras)

Execute update, insert or delete sql statement.

参数:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

paras - the parameters of sql

返回:

either the row count for INSERT, UPDATE, or DELETE statements, or 0 for SQL statements that return nothing

update

public int update(String sql)

参数:

sql - an SQL statement

另请参阅:

update(String, Object...)

findJsonField

protected List<Record> findJsonField(Config config,
                                     Connection conn,
                                     String sql,
                                     String[] jsonFields,
                                     Object... paras)
                              throws SQLException

抛出:

SQLException

find

protected List<Record> find(Config config,
                            Connection conn,
                            String sql,
                            Object... paras)
                     throws SQLException

抛出:

SQLException

find

protected <T> List<T> find(Class<T> clazz,
                           Config config,
                           Connection conn,
                           String sql,
                           Object... paras)

find

public List<Record> find(String sql,
                         Object... paras)

另请参阅:

findWithPrimaryKey(String, String, Object...)

findJsonField

public List<Record> findJsonField(String sql,
                                  String[] jsonFields,
                                  Object... paras)

findWithJsonField

public List<Record> findWithJsonField(String sql,
                                      String[] jsonFields,
                                      Object... paras)

find

public <T> List<T> find(Class<T> clazz,
                        String sql,
                        Object... paras)

find

public List<Record> find(String sql)

参数:

sql - the sql statement

另请参阅:

findWithPrimaryKey(String, String, Object...)

findWithJsonFields

public List<Record> findWithJsonFields(String sql,
                                       String[] jsonFields)

findAll

public List<Record> findAll(String tableName)

findAll

public <T> List<T> findAll(Class<T> clazz,
                           String tableName)

findColumnsAll

public List<Record> findColumnsAll(String tableName,
                                   String columns)

findColumnsAll

public <T> List<T> findColumnsAll(Class<T> clazz,
                                  String tableName,
                                  String columns)

findByColumn

public List<Record> findByColumn(String tableName,
                                 String column,
                                 String value)

findFirst

public Record findFirst(String sql,
                        Object... paras)

Find first record. I recommend add "limit 1" in your sql.

参数:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

paras - the parameters of sql

返回:

the Record object

findFirstJsonField

public Record findFirstJsonField(String sql,
                                 String[] jsonFields,
                                 Object... paras)

findFirst

public <T> T findFirst(Class<T> clazz,
                       String sql,
                       Object... paras)

findFirst

public Record findFirst(String sql)

参数:

sql - an SQL statement

另请参阅:

findFirst(String, Object...)

findById

public Record findById(String tableName,
                       Object idValue)

Find record by id with default primary key.

 Example:
 Record user = Db.use().findById("user", 15);
 

参数:

tableName - the table name of the table

idValue - the id value of the record

findById

public <T> T findById(Class<T> clazz,
                      String tableName,
                      Object idValue)

findColumnsById

public Record findColumnsById(String tableName,
                              String columns,
                              Object idValue)

findColumnsById

public <T> T findColumnsById(Class<T> clazz,
                             String tableName,
                             String columns,
                             Object idValue)

findById

public Record findById(String tableName,
                       String primaryKey,
                       Object idValue)

findById

public <T> T findById(Class<T> clazz,
                      String tableName,
                      String primaryKey,
                      Object idValue)

findByIds

public Record findByIds(String tableName,
                        String primaryKey,
                        Object... idValues)

Find record by ids.

 Example:
 Record user = Db.use().findByIds("user", "user_id", 123);
 Record userRole = Db.use().findByIds("user_role", "user_id, role_id", 123, 456);
 

参数:

tableName - the table name of the table

primaryKey - the primary key of the table, composite primary key is separated by comma character: ","

idValues - the id value of the record, it can be composite id values

findByIds

public <T> T findByIds(Class<T> clazz,
                       String tableName,
                       String primaryKey,
                       Object... idValues)

findColumnsByIds

public Record findColumnsByIds(String tableName,
                               String columns,
                               String primaryKey,
                               Object... idValues)

findColumnsByIds

public <T> T findColumnsByIds(Class<T> clazz,
                              String tableName,
                              String columns,
                              String primaryKey,
                              Object... idValues)

findWithPrimaryKey

public List<Record> findWithPrimaryKey(String tableName,
                                       String primaryKey,
                                       Object... idValues)

findColumnsById

public Record findColumnsById(String tableName,
                              String columns,
                              String primaryKey,
                              Object... idValues)

findColumnsById

public <T> T findColumnsById(Class<T> clazz,
                             String tableName,
                             String columns,
                             String primaryKey,
                             Object... idValues)

findColumns

public List<Record> findColumns(String tableName,
                                String columns,
                                String primaryKey,
                                Object... idValues)

deleteById

public boolean deleteById(String tableName,
                          Object idValue)

Delete record by id with default primary key.

 Example: Db.use().deleteById("user", 15);
 

参数:

tableName - the table name of the table

idValue - the id value of the record

返回:

true if delete succeed otherwise false

deleteById

public boolean deleteById(String tableName,
                          String primaryKey,
                          Object idValue)

deleteByIds

public boolean deleteByIds(String tableName,
                           String primaryKey,
                           Object... idValues)

Delete record by ids.

 Example: Db.use().deleteByIds("user", "user_id", 15);
 Db.use().deleteByIds("user_role", "user_id, role_id", 123, 456);
 

参数:

tableName - the table name of the table

primaryKey - the primary key of the table, composite primary key is separated by comma character: ","

idValues - the id value of the record, it can be composite id values

返回:

true if delete succeed otherwise false

delete

public boolean delete(String tableName,
                      String primaryKey,
                      Record record)

Delete record.

 Example:
 boolean succeed = Db.use().delete("user", "id", user);
 

参数:

tableName - the table name of the table

primaryKey - the primary key of the table, composite primary key is separated by comma character: ","

record - the record

返回:

true if delete succeed otherwise false

deleteByIds

public boolean deleteByIds(String tableName,
                           Record record)

 Example:
 boolean succeed = Db.use().delete("user", user);
 

另请参阅:

delete(String, String, Record)

delete

public boolean delete(String tableName,
                      Record record)

 Example:
 String noteId="0000000";
 Record removeRecordFilter = new Record();
 removeRecordFilter.set("note_id", noteId);
 Db.delete(ENoteTableNames.ENOTE_NOTE_TAG, removeRecordFilter);
 

delete

public int delete(String sql,
                  Object... paras)

Execute delete sql statement.

参数:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

paras - the parameters of sql

返回:

the row count for DELETE statements, or 0 for SQL statements that return nothing

delete

public int delete(String sql)

参数:

sql - an SQL statement

另请参阅:

delete(String, Object...)

paginate

public Page<Record> paginate(int pageNumber,
                             int pageSize,
                             String select,
                             String sqlExceptSelect,
                             Object... paras)

Paginate.

参数:

pageNumber - the page number

pageSize - the page size

select - the select part of the sql statement

sqlExceptSelect - the sql statement excluded select part

paras - the parameters of sql

返回:

the Page object

paginate

public <T> Page<T> paginate(Class<T> clazz,
                            int pageNumber,
                            int pageSize,
                            String select,
                            String sqlExceptSelect,
                            Object[] paras)

paginate

public Page<Record> paginate(int pageNumber,
                             int pageSize,
                             String select,
                             String sqlExceptSelect)

paginateJsonFields

public Page<Record> paginateJsonFields(int pageNumber,
                                       int pageSize,
                                       String select,
                                       String sqlExceptSelect,
                                       String[] jsonFields,
                                       Object... paras)

paginateJsonFields

public Page<Record> paginateJsonFields(int pageNumber,
                                       int pageSize,
                                       String select,
                                       String sqlExceptSelect,
                                       String[] jsonFields)

paginate

public Page<Record> paginate(int pageNumber,
                             int pageSize,
                             boolean isGroupBySql,
                             String select,
                             String sqlExceptSelect)

paginate

public <T> Page<T> paginate(Class<T> clazz,
                            int pageNumber,
                            int pageSize,
                            String select,
                            String sqlExceptSelect)

paginate

public <T> Page<T> paginate(Class<T> clazz,
                            int pageNumber,
                            int pageSize,
                            boolean isGroupBySql,
                            String select,
                            String sqlExceptSelect)

paginate

public Page<Record> paginate(int pageNumber,
                             int pageSize,
                             boolean isGroupBySql,
                             String select,
                             String sqlExceptSelect,
                             Object... paras)

paginate

public <T> Page<T> paginate(Class<T> clazz,
                            int pageNumber,
                            int pageSize,
                            boolean isGroupBySql,
                            String select,
                            String sqlExceptSelect,
                            Object[] paras)

doPaginateJsonFields

protected Page<Record> doPaginateJsonFields(int pageNumber,
                                            int pageSize,
                                            Boolean isGroupBySql,
                                            String select,
                                            String sqlExceptSelect,
                                            String[] jsonFields,
                                            Object... paras)

doPaginate

protected Page<Record> doPaginate(int pageNumber,
                                  int pageSize,
                                  Boolean isGroupBySql,
                                  String select,
                                  String sqlExceptSelect,
                                  Object... paras)

doPaginate

public <T> Page<T> doPaginate(Class<T> clazz,
                              int pageNumber,
                              int pageSize,
                              Boolean isGroupBySql,
                              String select,
                              String sqlExceptSelect,
                              Object... paras)

doPaginateByFullSqlWithJsonFields

protected Page<Record> doPaginateByFullSqlWithJsonFields(Config config,
                                                         Connection conn,
                                                         int pageNumber,
                                                         int pageSize,
                                                         Boolean isGroupBySql,
                                                         String totalRowSql,
                                                         StringBuilder findSql,
                                                         String[] jsonFields,
                                                         Object... paras)

doPaginateByFullSql

protected Page<Record> doPaginateByFullSql(Config config,
                                           Connection conn,
                                           int pageNumber,
                                           int pageSize,
                                           Boolean isGroupBySql,
                                           String totalRowSql,
                                           StringBuilder findSql,
                                           Object... paras)
                                    throws SQLException

抛出:

SQLException

doPaginateByFullSql

public <T> Page<T> doPaginateByFullSql(Class<T> clazz,
                                       Config config2,
                                       Connection conn,
                                       int pageNumber,
                                       int pageSize,
                                       Boolean isGroupBySql,
                                       String totalRowSql,
                                       StringBuilder findSql,
                                       Object[] paras)
                                throws SQLException

抛出:

SQLException

paginate

protected Page<Record> paginate(Config config,
                                Connection conn,
                                int pageNumber,
                                int pageSize,
                                String select,
                                String sqlExceptSelect,
                                Object... paras)
                         throws SQLException

抛出:

SQLException

doPaginateByFullSql

protected Page<Record> doPaginateByFullSql(int pageNumber,
                                           int pageSize,
                                           Boolean isGroupBySql,
                                           String totalRowSql,
                                           String findSql,
                                           Object... paras)

doPaginateByFullSql

protected <T> Page<T> doPaginateByFullSql(Class<T> clazz,
                                          int pageNumber,
                                          int pageSize,
                                          Boolean isGroupBySql,
                                          String totalRowSql,
                                          String findSql,
                                          Object... paras)

paginateByFullSql

public Page<Record> paginateByFullSql(int pageNumber,
                                      int pageSize,
                                      String totalRowSql,
                                      String findSql,
                                      Object... paras)

paginateByFullSql

public Page<Record> paginateByFullSql(int pageNumber,
                                      int pageSize,
                                      boolean isGroupBySql,
                                      String totalRowSql,
                                      String findSql,
                                      Object... paras)

paginateByFullSql

public <T> Page<T> paginateByFullSql(Class<T> clazz,
                                     int pageNumber,
                                     int pageSize,
                                     String totalRowSql,
                                     String findSql,
                                     Object... paras)

paginateByFullSql

public <T> Page<T> paginateByFullSql(Class<T> clazz,
                                     int pageNumber,
                                     int pageSize,
                                     boolean isGroupBySql,
                                     String totalRowSql,
                                     String findSql,
                                     Object... paras)

save

protected boolean save(Config config,
                       Connection conn,
                       String tableName,
                       String primaryKey,
                       Record record)

save

protected boolean save(Config config,
                       Connection conn,
                       String tableName,
                       String primaryKey,
                       Record record,
                       String[] jsonFields)

save

public boolean save(String tableName,
                    String primaryKey,
                    Record record)

Save record.

 Example:
 Record userRole = new Record().set("user_id", 123).set("role_id", 456);
 Db.use().save("user_role", "user_id, role_id", userRole);
 

参数:

tableName - the table name of the table

primaryKey - the primary key of the table, composite primary key is separated by comma character: ","

record - the record will be saved

save

public boolean save(String tableName,
                    String primaryKey,
                    Record record,
                    String[] jsonFields)

save

public boolean save(String tableName,
                    Record record)

另请参阅:

save(String, String, Record)

save

public boolean save(String tableName,
                    Record record,
                    String[] jsonFields)

参数:

tableName -

record -

jsonFields -

返回:

update

protected boolean update(Config config,
                         Connection conn,
                         String tableName,
                         String primaryKey,
                         Record record)
                  throws SQLException

抛出:

SQLException

update

protected boolean update(Config config,
                         Connection conn,
                         String tableName,
                         String primaryKey,
                         Record record,
                         String[] jsonFields)
                  throws SQLException

抛出:

SQLException

update

public boolean update(String tableName,
                      String primaryKey,
                      Record record)

Update Record.

 Example: Db.use().update("user_role", "user_id, role_id", record);
 

参数:

tableName - the table name of the Record save to

primaryKey - the primary key of the table, composite primary key is separated by comma character: ","

record - the Record object

update

public boolean update(String tableName,
                      String primaryKey,
                      Record record,
                      String[] jsonFields)

update

public boolean update(String tableName,
                      Record record)

Update record with default primary key.

 Example: Db.use().update("user", record);
 

另请参阅:

update(String, String, Record)

execute

public Object execute(ICallback callback)

execute

protected Object execute(Config config,
                         ICallback callback)

Execute callback. It is useful when all the API can not satisfy your requirement.

参数:

config - the Config object

callback - the ICallback interface

tx

protected boolean tx(Config config,
                     int transactionLevel,
                     IAtom atom)

Execute transaction.

参数:

config - the Config object

transactionLevel - the transaction level

atom - the atom operation

返回:

true if transaction executing succeed otherwise false

tx

public boolean tx(IAtom atom)

Execute transaction with default transaction level.

另请参阅:

tx(int, IAtom)

tx

public boolean tx(int transactionLevel,
                  IAtom atom)

txInNewThread

public Future<Boolean> txInNewThread(IAtom atom)

主要用于嵌套事务场景

实例：https://jfinal.com/feedback/4008

默认情况下嵌套事务会被合并成为一个事务，那么内层与外层任何地方回滚事务 所有嵌套层都将回滚事务，也就是说嵌套事务无法独立提交与回滚

使用 txInNewThread(...) 方法可以实现层之间的事务控制的独立性 由于事务处理是将 Connection 绑定到线程上的，所以 txInNewThread(...) 通过建立新线程来实现嵌套事务的独立控制

txInNewThread

public Future<Boolean> txInNewThread(int transactionLevel,
                                     IAtom atom)

findByCache

public List<Record> findByCache(String cacheName,
                                Object key,
                                String sql,
                                Object... paras)

Find Record by cache.

参数:

cacheName - the cache name

key - the key used to get date from cache

返回:

the list of Record

另请参阅:

find(String, Object...)

findByCache

public <T> List<T> findByCache(Class<T> clazz,
                               String cacheName,
                               Object key,
                               String sql,
                               Object... paras)

findByCache

public List<Record> findByCache(String cacheName,
                                Object key,
                                String sql)

另请参阅:

findByCache(String, Object, String, Object...)

findByCache

public <T> List<T> findByCache(Class<T> clazz,
                               String cacheName,
                               Object key,
                               String sql)

findFirstByCache

public Record findFirstByCache(String cacheName,
                               Object key,
                               String sql,
                               Object... paras)

Find first record by cache. I recommend add "limit 1" in your sql.

参数:

cacheName - the cache name

key - the key used to get date from cache

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

paras - the parameters of sql

返回:

the Record object

另请参阅:

findFirst(String, Object...)

findFirstByCache

public <T> T findFirstByCache(Class<T> clazz,
                              String cacheName,
                              Object key,
                              String sql,
                              Object... paras)

findFirstByCache

public Record findFirstByCache(String cacheName,
                               Object key,
                               String sql)

另请参阅:

findFirstByCache(String, Object, String, Object...)

findFirstByCache

public <T> T findFirstByCache(Class<T> clazz,
                              String cacheName,
                              Object key,
                              String sql)

doPaginateByCache

public <T> Page<T> doPaginateByCache(Class<T> clazz,
                                     String cacheName,
                                     Object key,
                                     int pageNumber,
                                     int pageSize,
                                     Boolean isGroupBySql,
                                     String select,
                                     String sqlExceptSelect,
                                     Object... paras)

doPaginateByCache

public Page<Record> doPaginateByCache(String cacheName,
                                      Object key,
                                      int pageNumber,
                                      int pageSize,
                                      Boolean isGroupBySql,
                                      String select,
                                      String sqlExceptSelect,
                                      Object... paras)

paginateByCache

public Page<Record> paginateByCache(String cacheName,
                                    Object key,
                                    int pageNumber,
                                    int pageSize,
                                    SqlPara sqlPara)

paginateByCache

public Page<Record> paginateByCache(String cacheName,
                                    Object key,
                                    int pageNumber,
                                    int pageSize,
                                    boolean isGroupBySql,
                                    SqlPara sqlPara)

paginateByCache

public Page<Record> paginateByCache(String cacheName,
                                    Object key,
                                    int pageNumber,
                                    int pageSize,
                                    String select,
                                    String sqlExceptSelect)

另请参阅:

paginateByCache(String, Object, int, int, String, String, Object...)

paginateByCache

public Page<Record> paginateByCache(String cacheName,
                                    Object key,
                                    int pageNumber,
                                    int pageSize,
                                    boolean isGroupBySql,
                                    String select,
                                    String sqlExceptSelect)

paginateByCache

public Page<Record> paginateByCache(String cacheName,
                                    Object key,
                                    int pageNumber,
                                    int pageSize,
                                    String select,
                                    String sqlExceptSelect,
                                    Object... paras)

Paginate by cache.

返回:

Page

另请参阅:

paginate(int, int, String, String, Object...)

paginateByCache

public Page<Record> paginateByCache(String cacheName,
                                    Object key,
                                    int pageNumber,
                                    int pageSize,
                                    boolean isGroupBySql,
                                    String select,
                                    String sqlExceptSelect,
                                    Object... paras)

paginateByCacheByFullSql

public Page<Record> paginateByCacheByFullSql(String cacheName,
                                             Object key,
                                             int pageNumber,
                                             int pageSize,
                                             String totalRowSql,
                                             String findSql,
                                             Object... paras)

paginateByCacheByFullSql

public Page<Record> paginateByCacheByFullSql(String cacheName,
                                             Object key,
                                             int pageNumber,
                                             int pageSize,
                                             boolean isGroupBySql,
                                             String totalRowSql,
                                             String findSql,
                                             Object... paras)

paginateByCacheByFullSql

public <T> Page<T> paginateByCacheByFullSql(Class<T> clazz,
                                            String cacheName,
                                            Object key,
                                            int pageNumber,
                                            int pageSize,
                                            String totalRowSql,
                                            String findSql,
                                            Object... paras)

paginateByCacheByFullSql

public <T> Page<T> paginateByCacheByFullSql(Class<T> clazz,
                                            String cacheName,
                                            Object key,
                                            int pageNumber,
                                            int pageSize,
                                            boolean isGroupBySql,
                                            String totalRowSql,
                                            String findSql,
                                            Object... paras)

paginateByCache

public <T> Page<T> paginateByCache(Class<T> clazz,
                                   String cacheName,
                                   Object key,
                                   int pageNumber,
                                   int pageSize,
                                   SqlPara sqlPara)

paginateByCache

public <T> Page<T> paginateByCache(Class<T> clazz,
                                   String cacheName,
                                   Object key,
                                   int pageNumber,
                                   int pageSize,
                                   boolean isGroupBySql,
                                   SqlPara sqlPara)

paginateByCache

public <T> Page<T> paginateByCache(Class<T> clazz,
                                   String cacheName,
                                   Object key,
                                   int pageNumber,
                                   int pageSize,
                                   String select,
                                   String sqlExceptSelect)

paginateByCache

public <T> Page<T> paginateByCache(Class<T> clazz,
                                   String cacheName,
                                   Object key,
                                   int pageNumber,
                                   int pageSize,
                                   boolean isGroupBySql,
                                   String select,
                                   String sqlExceptSelect)

paginateByCache

public <T> Page<T> paginateByCache(Class<T> clazz,
                                   String cacheName,
                                   Object key,
                                   int pageNumber,
                                   int pageSize,
                                   String select,
                                   String sqlExceptSelect,
                                   Object... paras)

paginateByCache

public <T> Page<T> paginateByCache(Class<T> clazz,
                                   String cacheName,
                                   Object key,
                                   int pageNumber,
                                   int pageSize,
                                   boolean isGroupBySql,
                                   String select,
                                   String sqlExceptSelect,
                                   Object... paras)

batch

protected int[] batch(Config config,
                      Connection conn,
                      String sql,
                      Object[][] paras,
                      int batchSize)
               throws SQLException

抛出:

SQLException

batch

public int[] batch(String sql,
                   Object[][] paras,
                   int batchSize)

Execute a batch of SQL INSERT, UPDATE, or DELETE queries.

 Example:
 String sql = "insert into user(name, cash) values(?, ?)";
 int[] result = Db.use().batch(sql, new Object[][]{{"James", 888}, {"zhanjin", 888}});
 

参数:

sql - The SQL to execute.

paras - An array of query replacement parameters. Each row in this array is one set of batch replacement values.

返回:

The number of rows updated per statement

batch

protected int[] batch(Config config,
                      Connection conn,
                      String sql,
                      String columns,
                      List list,
                      int batchSize)
               throws SQLException

抛出:

SQLException

batch

public int[] batch(String sql,
                   String columns,
                   List modelOrRecordList,
                   int batchSize)

Execute a batch of SQL INSERT, UPDATE, or DELETE queries.

 Example:
 String sql = "insert into user(name, cash) values(?, ?)";
 int[] result = Db.use().batch(sql, "name, cash", modelList, 500);
 

参数:

sql - The SQL to execute.

columns - the columns need be processed by sql.

modelOrRecordList - model or record object list.

batchSize - batch size.

返回:

The number of rows updated per statement

batch

protected int[] batch(Config config,
                      Connection conn,
                      List<String> sqlList,
                      int batchSize)
               throws SQLException

抛出:

SQLException

batch

public int[] batch(List<String> sqlList,
                   int batchSize)

Execute a batch of SQL INSERT, UPDATE, or DELETE queries.

 Example:
 int[] result = Db.use().batch(sqlList, 500);
 

参数:

sqlList - The SQL list to execute.

batchSize - batch size.

返回:

The number of rows updated per statement

batchSave

public int[] batchSave(List<? extends Model> modelList,
                       int batchSize)

Batch save models using the "insert into ..." sql generated by the first model in modelList. Ensure all the models can use the same sql as the first model.

batchSave

public int[] batchSave(String tableName,
                       List<? extends Record> recordList,
                       int batchSize)

Batch save records using the "insert into ..." sql generated by the first record in recordList. Ensure all the record can use the same sql as the first record.

参数:

tableName - the table name

batchDelete

public int[] batchDelete(String tableName,
                         List<? extends Record> recordList,
                         int batchSize)

batchUpdate

public int[] batchUpdate(List<? extends Model> modelList,
                         int batchSize)

Batch update models using the attrs names of the first model in modelList. Ensure all the models can use the same sql as the first model.

batchUpdate

public int[] batchUpdate(String tableName,
                         String primaryKey,
                         List<? extends Record> recordList,
                         int batchSize)

Batch update records using the columns names of the first record in recordList. Ensure all the records can use the same sql as the first record.

参数:

tableName - the table name

primaryKey - the primary key of the table, composite primary key is separated by comma character: ","

batchUpdate

public int[] batchUpdate(String tableName,
                         List<? extends Record> recordList,
                         int batchSize)

Batch update records with default primary key, using the columns names of the first record in recordList. Ensure all the records can use the same sql as the first record.

参数:

tableName - the table name

getSql

public String getSql(String key)

getSqlPara

public SqlPara getSqlPara(String key,
                          Record record)

getSqlPara

public SqlPara getSqlPara(String key,
                          Model model)

getSqlPara

public SqlPara getSqlPara(String key,
                          Map data)

getSqlPara

public SqlPara getSqlPara(String key,
                          Object... paras)

getSqlParaByString

public SqlPara getSqlParaByString(String content,
                                  Map data)

getSqlParaByString

public SqlPara getSqlParaByString(String content,
                                  Object... paras)

find

public List<Record> find(SqlPara sqlPara)

find

public <T> List<T> find(Class<T> clazz,
                        SqlPara sqlPara)

findFirst

public Record findFirst(SqlPara sqlPara)

findFirst

public <T> T findFirst(Class<T> clazz,
                       SqlPara sqlPara)

update

public int update(SqlPara sqlPara)

paginate

public Page<Record> paginate(int pageNumber,
                             int pageSize,
                             SqlPara sqlPara)

paginate

public <T> Page<T> paginate(Class<T> clazz,
                            int pageNumber,
                            int pageSize,
                            SqlPara sqlPara)

paginate

public Page<Record> paginate(int pageNumber,
                             int pageSize,
                             boolean isGroupBySql,
                             SqlPara sqlPara)

paginate

public <T> Page<T> paginate(Class<T> clazz,
                            int pageNumber,
                            int pageSize,
                            boolean isGroupBySql,
                            SqlPara sqlPara)

each

public void each(java.util.function.Function<Record,Boolean> func,
                 String sql,
                 Object... paras)

迭代处理每一个查询出来的 Record 对象

 例子：
 Db.each(record -> {
    // 处理 record 的代码在此

    // 返回 true 继续循环处理下一条数据，返回 false 立即终止循环
    return true;
 }, sql, paras);
 

template

public DbTemplate template(String key,
                           Map data)

template

public DbTemplate template(String key,
                           Object... paras)

templateByString

public DbTemplate templateByString(String content,
                                   Map data)

templateByString

public DbTemplate templateByString(String content,
                                   Object... paras)

exists

public boolean exists(String sql,
                      Object[] paras)

exists

public boolean exists(String tableName,
                      String fields,
                      Object... paras)

count

public Long count(String sql)

countTable

public Long countTable(String table)