com.jfinal.plugin.activerecord

类 DbPro

java.lang.Object

com.jfinal.plugin.activerecord.DbPro

public class DbPro
extends Object

DbPro. Professional database query and update tool.

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
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.
boolean	delete(String tableName, Record record) Example: boolean succeed = DbPro.use().delete("user", user);
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) Delete record by id.
Object	execute(ICallback callback)
List<Record>	find(String sql)
List<Record>	find(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.
Record	findById(String tableName, Object idValue) Find record by id with default primary key.
Record	findById(String tableName, String primaryKey, Object... idValue) Find record by id.
Record	findFirst(String sql)
Record	findFirst(String sql, Object... paras) Find first record.
Record	findFirstByCache(String cacheName, Object key, String sql)
Record	findFirstByCache(String cacheName, Object key, String sql, Object... paras) Find first record by cache.
Page<Record>	paginate(int pageNumber, int pageSize, String select, String sqlExceptSelect)
Page<Record>	paginate(int pageNumber, int pageSize, String select, String sqlExceptSelect, Object... paras)
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> List<T>	query(String sql)
<T> List<T>	query(String sql, Object... paras)
BigDecimal	queryBigDecimal(String sql)
BigDecimal	queryBigDecimal(String sql, Object... paras)
Boolean	queryBoolean(String sql)
Boolean	queryBoolean(String sql, Object... paras)
byte[]	queryBytes(String sql)
byte[]	queryBytes(String sql, Object... paras)
<T> T	queryColumn(String sql)
<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)
Long	queryLong(String sql)
Long	queryLong(String sql, Object... paras)
Number	queryNumber(String sql)
Number	queryNumber(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)
boolean	save(String tableName, Record record)
boolean	save(String tableName, String primaryKey, Record record) Save record.
boolean	tx(IAtom atom) Execute transaction with default transaction level.
boolean	tx(int transactionLevel, IAtom atom)
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.
static DbPro	use()
static DbPro	use(String configName)

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

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

构造器详细资料

DbPro

public DbPro()

DbPro

public DbPro(String configName)

方法详细资料

use

public static DbPro use(String configName)

use

public static DbPro use()

query

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

另请参阅:

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

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

返回:

List

queryColumn

public <T> T queryColumn(String sql)

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)

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)

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)

queryNumber

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

queryNumber

public Number queryNumber(String sql)

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...)

find

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

另请参阅:

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

find

public List<Record> find(String sql)

参数:

sql - the sql statement

另请参阅:

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

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

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 = DbPro.use().findById("user", 15);
 

参数:

tableName - the table name of the table

idValue - the id value of the record

findById

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

Find record by id.

 Example:
 Record user = DbPro.use().findById("user", "user_id", 123);
 Record userRole = DbPro.use().findById("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: ","

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

deleteById

public boolean deleteById(String tableName,
                          Object idValue)

Delete record by id with default primary key.

 Example: DbPro.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)

Delete record by id.

 Example: DbPro.use().deleteById("user", "user_id", 15);
 DbPro.use().deleteById("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: ","

idValue - 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 = DbPro.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

delete

public boolean delete(String tableName,
                      Record record)

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

另请参阅:

delete(String, String, Record)

paginate

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

另请参阅:

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

paginate

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

另请参阅:

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

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);
 DbPro.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

true - if save succeed otherwise false

save

public boolean save(String tableName,
                    Record record)

另请参阅:

save(String, String, Record)

update

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

Update Record.

 Example: DbPro.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

true - if update succeed otherwise false

update

public boolean update(String tableName,
                      Record record)

Update record with default primary key.

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

另请参阅:

update(String, String, Record)

execute

public Object execute(ICallback callback)

另请参阅:

#execute(String, ICallback)

tx

public boolean tx(int transactionLevel,
                  IAtom atom)

tx

public boolean tx(IAtom atom)

Execute transaction with default transaction level.

另请参阅:

tx(int, IAtom)

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 List<Record> findByCache(String cacheName,
                                Object key,
                                String sql)

另请参阅:

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

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 Record findFirstByCache(String cacheName,
                               Object key,
                               String sql)

另请参阅:

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

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,
                                    String select,
                                    String sqlExceptSelect)

另请参阅:

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

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 = DbPro.use().batch("myConfig", 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

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 = DbPro.use().batch("myConfig", 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

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

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

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

参数:

sqlList - The SQL list to execute.

batchSize - batch size.

返回:

The number of rows updated per statement