com.jfinal.plugin.activerecord

Class Db

java.lang.Object

com.jfinal.plugin.activerecord.Db

public class Db
extends Object

Db. Powerful database query and update tool box.

Constructor Summary

Constructors

Constructor and Description
Db()

Method Summary

Modifier and Type	Method and Description
static int[]	batch(List<String> sqlList, int batchSize)
static int[]	batch(String sql, Object[][] paras, int batchSize)
static int[]	batch(String sql, String columns, List modelOrRecordList, int batchSize)
static int[]	batchSave(List<? extends Model> modelList, int batchSize)
static int[]	batchSave(String tableName, List<Record> recordList, int batchSize)
static int[]	batchUpdate(List<? extends Model> modelList, int batchSize)
static int[]	batchUpdate(String tableName, List<Record> recordList, int batchSize)
static int[]	batchUpdate(String tableName, String primaryKey, List<Record> recordList, int batchSize)
static int	delete(String sql)
static int	delete(String sql, Object... paras) Execute delete sql statement.
static boolean	delete(String tableName, Record record) Example: boolean succeed = Db.delete("user", user);
static boolean	delete(String tableName, String primaryKey, Record record) Delete record.
static boolean	deleteById(String tableName, Object idValue) Delete record by id with default primary key.
static boolean	deleteById(String tableName, String primaryKey, Object... idValue) Delete record by id.
static Object	execute(ICallback callback)
static List<Record>	find(SqlPara sqlPara)
static List<Record>	find(String sql)
static List<Record>	find(String sql, Object... paras)
static List<Record>	findByCache(String cacheName, Object key, String sql)
static List<Record>	findByCache(String cacheName, Object key, String sql, Object... paras) Find Record by cache.
static Record	findById(String tableName, Object idValue) Find record by id with default primary key.
static Record	findById(String tableName, String primaryKey, Object... idValue) Find record by id.
static Record	findFirst(SqlPara sqlPara)
static Record	findFirst(String sql)
static Record	findFirst(String sql, Object... paras) Find first record.
static Record	findFirstByCache(String cacheName, Object key, String sql)
static Record	findFirstByCache(String cacheName, Object key, String sql, Object... paras) Find first record by cache.
static String	getSql(String key)
static SqlPara	getSqlPara(String key, Map data)
static SqlPara	getSqlPara(String key, Model model)
static SqlPara	getSqlPara(String key, Object... paras)
static SqlPara	getSqlPara(String key, Record record)
static Page<Record>	paginate(int pageNumber, int pageSize, boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras)
static Page<Record>	paginate(int pageNumber, int pageSize, SqlPara sqlPara)
static Page<Record>	paginate(int pageNumber, int pageSize, String select, String sqlExceptSelect)
static Page<Record>	paginate(int pageNumber, int pageSize, String select, String sqlExceptSelect, Object... paras) Paginate.
static Page<Record>	paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras)
static Page<Record>	paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, String select, String sqlExceptSelect)
static Page<Record>	paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, String select, String sqlExceptSelect, Object... paras) Paginate by cache.
static Page<Record>	paginateByFullSql(int pageNumber, int pageSize, boolean isGroupBySql, String totalRowSql, String findSql, Object... paras)
static Page<Record>	paginateByFullSql(int pageNumber, int pageSize, String totalRowSql, String findSql, Object... paras)
static <T> List<T>	query(String sql)
static <T> List<T>	query(String sql, Object... paras)
static BigDecimal	queryBigDecimal(String sql)
static BigDecimal	queryBigDecimal(String sql, Object... paras)
static Boolean	queryBoolean(String sql)
static Boolean	queryBoolean(String sql, Object... paras)
static Byte	queryByte(String sql)
static Byte	queryByte(String sql, Object... paras)
static byte[]	queryBytes(String sql)
static byte[]	queryBytes(String sql, Object... paras)
static <T> T	queryColumn(String sql)
static <T> T	queryColumn(String sql, Object... paras) Execute sql query just return one column.
static Date	queryDate(String sql)
static Date	queryDate(String sql, Object... paras)
static Double	queryDouble(String sql)
static Double	queryDouble(String sql, Object... paras)
static <T> T	queryFirst(String sql)
static <T> T	queryFirst(String sql, Object... paras) Execute sql query and return the first result.
static Float	queryFloat(String sql)
static Float	queryFloat(String sql, Object... paras)
static Integer	queryInt(String sql)
static Integer	queryInt(String sql, Object... paras)
static Long	queryLong(String sql)
static Long	queryLong(String sql, Object... paras)
static Number	queryNumber(String sql)
static Number	queryNumber(String sql, Object... paras)
static Short	queryShort(String sql)
static Short	queryShort(String sql, Object... paras)
static String	queryStr(String sql)
static String	queryStr(String sql, Object... paras)
static Time	queryTime(String sql)
static Time	queryTime(String sql, Object... paras)
static Timestamp	queryTimestamp(String sql)
static Timestamp	queryTimestamp(String sql, Object... paras)
static boolean	save(String tableName, Record record)
static boolean	save(String tableName, String primaryKey, Record record) Save record.
static boolean	tx(IAtom atom) Execute transaction with default transaction level.
static boolean	tx(int transactionLevel, IAtom atom)
static int	update(SqlPara sqlPara)
static int	update(String sql)
static int	update(String sql, Object... paras) Execute update, insert or delete sql statement.
static boolean	update(String tableName, Record record) Update record with default primary key.
static boolean	update(String tableName, String primaryKey, Record record) Update Record.
static DbPro	use()
static DbPro	use(String configName)

Methods inherited from class java.lang.Object

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

Constructor Detail

Db

public Db()

Method Detail

use

public static DbPro use(String configName)

use

public static DbPro use()

query

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

See Also:

#query(String, String, Object...)

query

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

Parameters:

sql - an SQL statement

See Also:

query(String, Object...)

queryFirst

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

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

Parameters:

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

paras - the parameters of sql

Returns:

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

queryFirst

public static <T> T queryFirst(String sql)

Parameters:

sql - an SQL statement

See Also:

queryFirst(String, Object...)

queryColumn

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

Execute sql query just return one column.

Type Parameters:

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

Parameters:

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

paras - the parameters of sql

Returns:

T

queryColumn

public static <T> T queryColumn(String sql)

queryStr

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

queryStr

public static String queryStr(String sql)

queryInt

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

queryInt

public static Integer queryInt(String sql)

queryLong

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

queryLong

public static Long queryLong(String sql)

queryDouble

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

queryDouble

public static Double queryDouble(String sql)

queryFloat

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

queryFloat

public static Float queryFloat(String sql)

queryBigDecimal

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

queryBigDecimal

public static BigDecimal queryBigDecimal(String sql)

queryBytes

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

queryBytes

public static byte[] queryBytes(String sql)

queryDate

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

queryDate

public static Date queryDate(String sql)

queryTime

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

queryTime

public static Time queryTime(String sql)

queryTimestamp

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

queryTimestamp

public static Timestamp queryTimestamp(String sql)

queryBoolean

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

queryBoolean

public static Boolean queryBoolean(String sql)

queryShort

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

queryShort

public static Short queryShort(String sql)

queryByte

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

queryByte

public static Byte queryByte(String sql)

queryNumber

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

queryNumber

public static Number queryNumber(String sql)

update

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

Execute update, insert or delete sql statement.

Parameters:

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

paras - the parameters of sql

Returns:

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

update

public static int update(String sql)

Parameters:

sql - an SQL statement

See Also:

update(String, Object...)

find

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

See Also:

#find(String, String, Object...)

find

public static List<Record> find(String sql)

Parameters:

sql - the sql statement

See Also:

#find(String, String, Object...)

findFirst

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

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

Parameters:

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

paras - the parameters of sql

Returns:

the Record object

findFirst

public static Record findFirst(String sql)

Parameters:

sql - an SQL statement

See Also:

findFirst(String, Object...)

findById

public static Record findById(String tableName,
                              Object idValue)

Find record by id with default primary key.

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

Parameters:

tableName - the table name of the table

idValue - the id value of the record

findById

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

Find record by id.

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

Parameters:

tableName - the table name of the table

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

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

deleteById

public static boolean deleteById(String tableName,
                                 Object idValue)

Delete record by id with default primary key.

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

Parameters:

tableName - the table name of the table

idValue - the id value of the record

Returns:

true if delete succeed otherwise false

deleteById

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

Delete record by id.

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

Parameters:

tableName - the table name of the table

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

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

Returns:

true if delete succeed otherwise false

delete

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

Delete record.

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

Parameters:

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

Returns:

true if delete succeed otherwise false

delete

public static boolean delete(String tableName,
                             Record record)

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

See Also:

delete(String, String, Record)

delete

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

Execute delete sql statement.

Parameters:

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

paras - the parameters of sql

Returns:

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

delete

public static int delete(String sql)

Parameters:

sql - an SQL statement

See Also:

delete(String, Object...)

paginate

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

Paginate.

Parameters:

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

Returns:

the Page object

paginate

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

paginate

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

See Also:

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

paginateByFullSql

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

paginateByFullSql

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

save

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

Save record.

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

Parameters:

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

true - if save succeed otherwise false

save

public static boolean save(String tableName,
                           Record record)

See Also:

save(String, String, Record)

update

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

Update Record.

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

Parameters:

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

true - if update succeed otherwise false

update

public static boolean update(String tableName,
                             Record record)

Update record with default primary key.

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

See Also:

update(String, String, Record)

execute

public static Object execute(ICallback callback)

See Also:

#execute(String, ICallback)

tx

public static boolean tx(int transactionLevel,
                         IAtom atom)

tx

public static boolean tx(IAtom atom)

Execute transaction with default transaction level.

See Also:

tx(int, IAtom)

findByCache

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

Find Record by cache.

Parameters:

cacheName - the cache name

key - the key used to get date from cache

Returns:

the list of Record

See Also:

find(String, Object...)

findByCache

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

See Also:

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

findFirstByCache

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

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

Parameters:

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

Returns:

the Record object

See Also:

findFirst(String, Object...)

findFirstByCache

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

See Also:

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

paginateByCache

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

Paginate by cache.

Returns:

Page

See Also:

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

paginateByCache

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

paginateByCache

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

See Also:

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

batch

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

See Also:

DbPro.batch(String, Object[][], int)

batch

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

See Also:

DbPro.batch(String, String, List, int)

batch

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

See Also:

DbPro.batch(List, int)

batchSave

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

See Also:

DbPro.batchSave(List, int)

batchSave

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

See Also:

DbPro.batchSave(String, List, int)

batchUpdate

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

See Also:

DbPro.batchUpdate(List, int)

batchUpdate

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

See Also:

DbPro.batchUpdate(String, String, List, int)

batchUpdate

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

See Also:

DbPro.batchUpdate(String, List, int)

getSql

public static String getSql(String key)

getSqlPara

public static SqlPara getSqlPara(String key,
                                 Record record)

getSqlPara

public static SqlPara getSqlPara(String key,
                                 Model model)

getSqlPara

public static SqlPara getSqlPara(String key,
                                 Map data)

getSqlPara

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

find

public static List<Record> find(SqlPara sqlPara)

findFirst

public static Record findFirst(SqlPara sqlPara)

update

public static int update(SqlPara sqlPara)

paginate

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