org.teasoft.bee.osql

Interface PreparedSql

All Superinterfaces:

CommOperate

public interface PreparedSql
extends CommOperate

Support sql string with placeholder.The sql statement is really DB's grammar,not object oriented type.
Support placeholder ? or #{para} or #{para%} or #{%para} or #{%para%},
can prevent SQL injection attacks through Preparedstatement

If possible, it is recommended to use object-oriented operation methods, such as Suid and SuidRich.
It can use Bee cache to achieve higher query efficiency.
Notice:
PreparedSql method which no T parameter, is not associated with entity, in the case of
multiple dataSource, will be select the record from the default dataSource.
from V1.11 version, can set the dataSource name.

Since:

1.0

Support map parameter forms such as name = #{name}, name like #{name%}

, 1.2

Author:

Kingstar

Method Summary

Modifier and Type	Method and Description
int	insertBatch(String sql, List<Map<String,Object>> parameterMapList) Insert records by batch type.
int	insertBatch(String sql, List<Map<String,Object>> parameterMapList, int batchSize) Insert records by batch type and batchSize.
int	modify(String sql) Deprecated. It is not recommended because the framework does not know what table has been changed, which will affect the correctness of the cache and cause the risk of inaccurate cache data.
int	modify(String sql, Map<String,Object> map) Deprecated. It is not recommended because the framework does not know what table has been changed, which will affect the correctness of the cache and cause the risk of inaccurate cache data.
int	modify(String sql, Object[] preValues) Deprecated. It is not recommended because the framework does not know what table has been changed, which will affect the correctness of the cache and cause the risk of inaccurate cache data.
<T> List<T>	moreTableSelect(String sql, T returnType) Select more table record(s) via no placeholder(?) select statement.
<T> List<T>	moreTableSelect(String sqlStr, T entity, Map<String,Object> parameterMap) Select the more table record(s) via the placeholder statement of variable.
<T> List<T>	moreTableSelect(String sqlStr, T entity, Map<String,Object> parameterMap, int start, int size) Select the more table record(s) via the placeholder statement of variable.Both entity and map can pass values to parameters.
List<String[]>	select(String sql) Select record(s) via the sql statement.
List<String[]>	select(String sqlStr, Map<String,Object> map) Select and transform every record to string array.
List<String[]>	select(String sqlStr, Map<String,Object> map, int start, int size) Select and transform every record to string array.
List<String[]>	select(String sql, Object[] preValues) Select and transform every record to string array.
List<String[]>	select(String sql, Object[] preValues, int start, int size) Select and transform every record to string array.
<T> List<T>	select(String sql, T returnType) Select record(s) via no placeholder(?) select statement.
<T> List<T>	select(String sqlStr, T entity, Map<String,Object> parameterMap) Select the record(s) via the placeholder statement of variable.Both entity and map can pass values to parameters.
<T> List<T>	select(String sqlStr, T entity, Map<String,Object> parameterMap, int start, int size) Select the record(s) via the placeholder statement of variable.Both entity and map can pass values to parameters.
<T> List<T>	select(String sql, T returnType, Object[] preValues) Select record(s) via the placeholder(?) statement.
<T> List<T>	select(String sql, T returnType, Object[] preValues, int start, int size) Select record(s) via the placeholder(?) statement,paging generate by Bee.
String	selectFun(String sql) Select result with function.
String	selectFun(String sqlStr, Map<String,Object> parameterMap) Select result with function.
String	selectFun(String sql, Object[] preValues) Select result with function.
String	selectJson(String sqlStr) Select and return json format result.
String	selectJson(String sqlStr, Map<String,Object> map) Select and return json format result.
String	selectJson(String sqlStr, Map<String,Object> map, int start, int size) Select and return json format result.
String	selectJson(String sql, Object[] preValues) Select and return json format result.
String	selectJson(String sql, Object[] preValues, int start, int size) Select and return json format result.
List<Map<String,Object>>	selectMapList(String sql) Query records and return list structure data whose element is Map.
List<Map<String,Object>>	selectMapList(String sqlStr, Map<String,Object> parameterMap) Query records and return list structure data whose element is Map.
List<Map<String,Object>>	selectMapList(String sql, Map<String,Object> parameterMap, int start, int size) Query records and return list structure data whose element is Map.
<T> List<T>	selectSomeField(String sqlStr, T entity, Map<String,Object> parameterMap) Select some column of the record(s) via the placeholder statement of variable.Both entity and map can pass values to parameters.
<T> List<T>	selectSomeField(String sqlStr, T entity, Map<String,Object> parameterMap, int start, int size) Select some column of the record(s) via the placeholder statement of variable.Both entity and map can pass values to parameters.
<T> List<T>	selectSomeField(String sql, T returnType, Object[] preValues) Select some column of record(s) via the placeholder(?) statement. eg: select * from orders where userid=?
<T> List<T>	selectSomeField(String sql, T returnType, Object[] preValues, int start, int size) Select some column of record(s) via the placeholder(?) statement,paging generate by Bee.

Methods inherited from interface org.teasoft.bee.osql.CommOperate

getDataSourceName, getInterceptorChain, setDataSourceName, setNameTranslateOneTime

Method Detail

select

<T> List<T> select(String sql,
                   T returnType,
                   Object[] preValues)

Select record(s) via the placeholder(?) statement.
eg: select * from orders where userid=?

Parameters:

sql - SQL select statement which direct use ? as placeholder

returnType - its type same as list element.

preValues - An object array that values set for the SQL placeholders in index order.

Returns:

List which element type is same as returnType.

select

<T> List<T> select(String sql,
                   T returnType)

Select record(s) via no placeholder(?) select statement.

Parameters:

sql - SQL select statement(no placeholder).

returnType - its type same as list element.

Returns:

List which element type is same as returnType.

Since:

V1.11

select

<T> List<T> select(String sql,
                   T returnType,
                   Object[] preValues,
                   int start,
                   int size)

Select record(s) via the placeholder(?) statement,paging generate by Bee.
eg: select * from orders where userid=?

Parameters:

sql - SQL select statement(use ? placeholder).

returnType - its type same as list element.

preValues - An object array that values set for the SQL placeholders in index order.

start - Start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - Fetch result size (>0).

Returns:

List which element type is same as returnType.

select

<T> List<T> select(String sqlStr,
                   T entity,
                   Map<String,Object> parameterMap)

Select the record(s) via the placeholder statement of variable.Both entity and map can pass values to parameters.
Map can be used as a supplement of entity to pass parameters of complex queries such as range query.
eg:select * from orders where userid=#{userid}
eg:select * from orders where name like #{name%}

Parameters:

sqlStr - SQL select statement(use #{para} placeholder).

entity - The non null value in entity will be converted into the element of map as the parameter,
and the field of entity will be automatically converted into the column name of the table.
Entity will also act as the type of the return structure.

parameterMap - The parameters of map structure correspond, the variable name in sqlstr correspond the key of map.
If the key of the map element is the same as that transferred from the entity, the key of the map will be used.

Returns:

Entity List which element type is same as entity.

select

<T> List<T> select(String sqlStr,
                   T entity,
                   Map<String,Object> parameterMap,
                   int start,
                   int size)

Select the record(s) via the placeholder statement of variable.Both entity and map can pass values to parameters.
Map can be used as a supplement of entity to pass parameters of complex queries such as range query.
paging generate by Bee
eg:select * from orders where userid=#{userid}
eg:select * from orders where name like #{name%}

Parameters:

sqlStr - SQL select statement(use #{para} placeholder).

entity - The non null value in entity will be converted into the element of map as the parameter,
and the field of entity will be automatically converted into the column name of the table.
Entity will also act as the type of the return structure.

parameterMap - The parameters of map structure correspond, the variable name in sqlstr correspond the key of map.
If the key of the map element is the same as that transferred from the entity, the key of the map will be used.

start - Start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - Fetch result size (>0).

Returns:

Entity List which element type is same as entity.

selectSomeField

<T> List<T> selectSomeField(String sql,
                            T returnType,
                            Object[] preValues)

Select some column of record(s) via the placeholder(?) statement.
eg: select * from orders where userid=?

Parameters:

sql - SQL select statement(use ? placeholder).

returnType - its type same as list element.

preValues - An object array that values set for the SQL placeholders in index order.

Returns:

List which element type is same as returnType.

selectSomeField

<T> List<T> selectSomeField(String sql,
                            T returnType,
                            Object[] preValues,
                            int start,
                            int size)

Select some column of record(s) via the placeholder(?) statement,paging generate by Bee.

eg: select * from orders where userid=?

Parameters:

sql - SQL select statement(use ? placeholder).

returnType - its type same as list element.

preValues - An object array that values set for the SQL placeholders in index order.

start - Start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - Fetch result size (>0).

Returns:

List which element type is same as returnType.

selectSomeField

<T> List<T> selectSomeField(String sqlStr,
                            T entity,
                            Map<String,Object> parameterMap)

Select some column of the record(s) via the placeholder statement of variable.Both entity and map can pass values to parameters.
Map can be used as a supplement of entity to pass parameters of complex queries such as range query.
eg:select * from orders where userid=#{userid}
eg:select * from orders where name like #{name%}

Parameters:

sqlStr - SQL select statement(use #{para} placeholder).

entity - The non null value in entity will be converted into the element of map as the parameter,
and the field of entity will be automatically converted into the column name of the table.
Entity will also act as the type of the return structure.

parameterMap - The parameters of map structure correspond, the variable name in sqlstr correspond the key of map.
If the key of the map element is the same as that transferred from the entity, the key of the map will be used.

Returns:

Entity List which element type is same as entity.

selectSomeField

<T> List<T> selectSomeField(String sqlStr,
                            T entity,
                            Map<String,Object> parameterMap,
                            int start,
                            int size)

Select some column of the record(s) via the placeholder statement of variable.Both entity and map can pass values to parameters.
Map can be used as a supplement of entity to pass parameters of complex queries such as range query.

paging generate by Bee
eg:select * from orders where userid=#{userid}
eg:select * from orders where name like #{name%}

Parameters:

sqlStr - SQL select statement(use #{para} placeholder).

entity - The non null value in entity will be converted into the element of map as the parameter,
and the field of entity will be automatically converted into the column name of the table.
Entity will also act as the type of the return structure.

parameterMap - The parameters of map structure correspond, the variable name in sqlstr correspond the key of map.
If the key of the map element is the same as that transferred from the entity, the key of the map will be used.

start - Start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - Fetch result size (>0).

Returns:

Entity List which element type is same as entity.

selectFun

String selectFun(String sql,
                 Object[] preValues)

Select result with function. SQL function: max,min,avg,sum,count.

Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.

Parameters:

sql - SQL select statement(use ? placeholder).

preValues - An object array that values set for the SQL placeholders in index order.

Returns:

The value of function statistics.
If the result set of statistics is empty,the count return 0,the other return empty string.

selectFun

String selectFun(String sqlStr,
                 Map<String,Object> parameterMap)

Select result with function. SQL function: max,min,avg,sum,count.

Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.

Parameters:

sqlStr - SQL select statement

parameterMap - The parameters of map structure correspond, the variable name in sqlStr correspond the key of map.

Returns:

The value of function statistics.
If the result set of statistics is empty,the count return 0,the other return empty string.

select

List<String[]> select(String sql,
                      Object[] preValues)

Select and transform every record to string array.

Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.

Parameters:

sql - SQL select statement(use ? placeholder).

preValues - parameter values for placeholder

Returns:

List can contain more than one record with String array struct.
List, every element is string array(transform from record).

select

List<String[]> select(String sql,
                      Object[] preValues,
                      int start,
                      int size)

Select and transform every record to string array.
Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.
paging generate by Bee.

Parameters:

sql - SQL select statement(use ? placeholder).

preValues - parameter values for placeholder

start - Start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - Fetch result size (>0).

Returns:

List can contain more than one record with String array struct.
List, every element is string array(transform from record).

select

List<String[]> select(String sqlStr,
                      Map<String,Object> map)

Select and transform every record to string array.
Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.

Parameters:

sqlStr - SQL select statement

map - parameter values for placeholder

Returns:

list can contain more than one record with String array struct. List, every element is string array(transform from record).

select

List<String[]> select(String sqlStr,
                      Map<String,Object> map,
                      int start,
                      int size)

Select and transform every record to string array.
Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.
paging generate by Bee.

Parameters:

sqlStr - SQL select statement

map - parameter values for placeholder

start - Start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - Fetch result size (>0).

Returns:

list can contain more than one record with String array struct. List, every element is string array(transform from record).

selectJson

String selectJson(String sql,
                  Object[] preValues)

Select and return json format result.
Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.

Parameters:

sql - SQL select statement(use ? placeholder).

preValues - parameter values for placeholder

Returns:

Json format result.

selectJson

String selectJson(String sql,
                  Object[] preValues,
                  int start,
                  int size)

Select and return json format result.
Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.
paging generate by Bee.

Parameters:

sql - SQL select statement(use ? placeholder).

preValues - parameter values for placeholder

start - Start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - Fetch result size (>0).

Returns:

Json format result.

selectJson

String selectJson(String sqlStr,
                  Map<String,Object> map)

Select and return json format result.
Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.

Parameters:

sqlStr - SQL select statement

map - parameter values for placeholder

Returns:

Json format result.

selectJson

String selectJson(String sqlStr,
                  Map<String,Object> map,
                  int start,
                  int size)

Select and return json format result.
Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.
paging generate by Bee.

Parameters:

sqlStr - SQL select statement

map - parameter values for placeholder

start - Start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - Fetch result size (>0).

Returns:

Json format result.

selectJson

String selectJson(String sqlStr)

Select and return json format result.

Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.

Parameters:

sqlStr - SQL select statement(do not contain placeholder)

Returns:

Json format result.

select

List<String[]> select(String sql)

Select record(s) via the sql statement.
Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource. eg: select * from orders where userid=10001

Parameters:

sql - SQL select statement(do not contain placeholder)

Returns:

List can contain more than one record with String array struct.
List, every element is string array(transform from record).

selectFun

String selectFun(String sql)

Select result with function. SQL function: max,min,avg,sum,count.

Notice:can not use the cache because don't relay the entity.
Because it is not associated with entity, in the case of multiple dataSource,
will be select the record from the default dataSource.

Parameters:

sql - SQL select statement(do not contain placeholder)

Returns:

The value of function statistics.
If the result set of statistics is empty,the count return 0,the other return empty string.

modify

@Deprecated
int modify(String sql,
                        Object[] preValues)

Deprecated. It is not recommended because
the framework does not know what table has been changed, which will affect the correctness
of the cache and cause the risk of inaccurate cache data.

Modify database records with update, insert or delete statement.

Parameters:

sql - SQL select statement(use ? placeholder).

preValues - parameter values for placeholder

Returns:

the number of affected successfully records.

modify

@Deprecated
int modify(String sql,
                        Map<String,Object> map)

Deprecated. It is not recommended because the framework does not know what table has been changed, which will affect the correctness of the cache and cause the risk of inaccurate cache data.

Modify database records with update, insert or delete statement.

Parameters:

sql - SQL statement.

map - parameter values for placeholder

Returns:

the number of affected successfully records.

modify

@Deprecated
int modify(String sql)

Deprecated. It is not recommended because the framework does not know what table has been changed,
which will affect the correctness of the cache and cause the risk of inaccurate cache data.

Modify database records with update, insert or delete statement.

Parameters:

sql - SQL statement.

Returns:

the number of affected successfully records.

Since:

1.9

selectMapList

List<Map<String,Object>> selectMapList(String sql)

Query records and return list structure data whose element is Map.

Parameters:

sql - SQL statement(do not contain placeholder).

Returns:

the multi-line record of List> structure.

selectMapList

List<Map<String,Object>> selectMapList(String sqlStr,
                                       Map<String,Object> parameterMap)

Query records and return list structure data whose element is Map.

Parameters:

sqlStr - SQL statement.

parameterMap - The parameters of map structure correspond, the variable name in sqlStr correspond the key of map.

Returns:

the multi-line record of List> structure.

Since:

V1.11

selectMapList

List<Map<String,Object>> selectMapList(String sql,
                                       Map<String,Object> parameterMap,
                                       int start,
                                       int size)

Query records and return list structure data whose element is Map.
paging generate by Bee.

Parameters:

sql - SQL statement.

parameterMap -

start - Start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - Fetch result size (>0).

Returns:

the multi-line record of List> structure.

Since:

V1.11

moreTableSelect

<T> List<T> moreTableSelect(String sql,
                            T returnType)

Select more table record(s) via no placeholder(?) select statement.

Parameters:

sql - SQL select statement(no placeholder).

returnType - its type same as list element.

Returns:

List which element type is same as returnType.

Since:

V1.11

moreTableSelect

<T> List<T> moreTableSelect(String sqlStr,
                            T entity,
                            Map<String,Object> parameterMap)

Select the more table record(s) via the placeholder statement of variable.
Both entity and map can pass values to parameters.
Map can be used as a supplement of entity to pass parameters of complex queries such as range query.
eg:select * from orders where userid=#{userid}
eg:select * from orders where name like #{name%}
Only the data of the main table is parsed as a parameter.

Parameters:

sqlStr - SQL select statement(use #{para} placeholder).

entity - The non null value in entity will be converted into the element of map as the parameter,
and the field of entity will be automatically converted into the column name of the table.
Entity will also act as the type of the return structure.

parameterMap - The parameters of map structure correspond, the variable name in sqlstr correspond the key of map.
If the key of the map element is the same as that transferred from the entity, the key of the map will be used.

Returns:

Entity List which element type is same as entity.

Since:

V1.11

moreTableSelect

<T> List<T> moreTableSelect(String sqlStr,
                            T entity,
                            Map<String,Object> parameterMap,
                            int start,
                            int size)

Select the more table record(s) via the placeholder statement of variable.Both entity and map can pass values to parameters.
Map can be used as a supplement of entity to pass parameters of complex queries such as range query.
paging generate by Bee
eg:select * from orders where userid=#{userid}
eg:select * from orders where name like #{name%}
Only the data of the main table is parsed as a parameter.

Parameters:

sqlStr - SQL select statement(use #{para} placeholder).

entity - The non null value in entity will be converted into the element of map as the parameter,
and the field of entity will be automatically converted into the column name of the table.
Entity will also act as the type of the return structure.

parameterMap - The parameters of map structure correspond, the variable name in sqlstr correspond the key of map.
If the key of the map element is the same as that transferred from the entity, the key of the map will be used.

start - Start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - Fetch result size (>0).

Returns:

Entity List which element type is same as entity.

Since:

V1.11

insertBatch

int insertBatch(String sql,
                List<Map<String,Object>> parameterMapList)

Insert records by batch type.

Parameters:

sql -

parameterMapList - every element of List is a map corresponds to one record, every field add in map struct.

Returns:

the number of inserted record(s) successfully;if fails, return -1.

Since:

1.11

insertBatch

int insertBatch(String sql,
                List<Map<String,Object>> parameterMapList,
                int batchSize)

Insert records by batch type and batchSize.

Parameters:

sql -

parameterMapList - every element of List is a map corresponds to one record, every field add in map struct.

batchSize -

Returns:

the number of inserted record(s) successfully;if fails, return -1.

Since:

1.11