org.teasoft.bee.osql.api.cqrs

Interface Command

All Superinterfaces:

CommOperate

public interface Command
extends CommOperate

Command type API.

Since:

2.5.2

Author:

Kingstar

Method Summary

Modifier and Type	Method and Description
void	beginSameConnection() declare begin Same Connection for some ORM operation.
<T> boolean	createTable(Class<T> entityClass, boolean isDropExistTable) According to the database table generated by JavaBean, JavaBean does not need to configure too much field information.
<T> int	delete(T entity) According to entity object delete record.
<T> int	delete(T entity, Condition condition) Delete the records according to entity and condition.
int	deleteById(Class<?> c, Integer id) Delete record by id.
int	deleteById(Class<?> c, Long id) Delete record by id.
int	deleteById(Class<?> c, String ids) Delete record by id.
<T> void	dropIndex(Class<T> entityClass, String indexName) drop index
void	endSameConnection() declare end Same Connection for some ORM operation.
<T> void	indexNormal(Class<T> entityClass, String fields, String indexName) create normal index
<T> int	insert(List<T> entityList) Insert records by batch type.
<T> int	insert(List<T> entityList, int batchSize) Insert records by batch type.
<T> int	insert(List<T> entityList, int batchSize, String excludeFields) Insert record by batch type,and can point out which field(s) don't need to insert.
<T> int	insert(List<T> entityList, String excludeFields) Insert record by batch type,and can point out which field(s) don't need to insert.
<T> int	insert(T entity) According to entity object insert record.
<T> int	insert(T[] entity) Insert records by batch type.
<T> int	insert(T[] entity, int batchSize) Insert records by batch type.
<T> int	insert(T[] entity, int batchSize, String excludeFields) Insert record by batch type,and can point out which field(s) don't need to insert.
<T> int	insert(T[] entity, String excludeFields) Insert record by batch type,and can point out which field(s) don't need to insert.
<T> int	insert(T entity, IncludeType includeType) Insert record according to entity.
<T> long	insertAndReturnId(T entity) According to entity object insert record and return id value.
<T> long	insertAndReturnId(T entity, IncludeType includeType) According to entity object insert record and return id value.
<T> void	primaryKey(Class<T> entityClass, String fields, String keyName) create primaryKey index
<T> int	save(T entity) save one entity(one record).
<T> void	unique(Class<T> entityClass, String fields, String indexName) create unique index
<T> int	update(T entity) According to entity object update record(update record by id).This method just has id field to SQL where expression.
<T> int	update(T entity, Condition condition) Update record,and can help with Condition.
<T> int	update(T entity, Condition condition, String... updateFields) Update record, can list update fields.
<T> int	update(T entity, IncludeType includeType) Update record according to entity by primary key.
<T> int	update(T entity, IncludeType includeType, String... updateFields) Update record according to entity.
<T> int	update(T entity, String... updateFields) Update record, can list update fields.
<T> int	update(T oldEntity, T newEntity) Update the entity.
<T> int	updateBy(T entity, Condition condition, String... whereFields) Update record according to whereFields.
<T> int	updateBy(T entity, IncludeType includeType, String... whereFields) Update record according to whereFields.
<T> int	updateBy(T entity, String... whereFields) Update record according to whereFields.
<T> int	updateById(T entity, Condition condition) it is equivalent to updateBy(entity,"id",condition)

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

getDataSourceName, getInterceptorChain, setDataSourceName, setNameTranslateOneTime

Method Detail

update

<T> int update(T entity)

According to entity object update record(update record by id).This method just has id field to SQL where expression. table's entity(do not allow null);id is where condition,do not allow null.
The entity corresponding to table and can not be null.
The ID field of entity cannot be null and as filter condition.
The not null and not empty field will update to database except ID.

Returns:

the numbers of update records successfully, if fails,return integer less than 0.

See Also:

update(Object,java.lang.String...)

insert

<T> int insert(T entity)

According to entity object insert record.

Parameters:

entity - table's entity(do not allow null).
The entity corresponding to table and can not be null.
The not null and not empty field will insert to database.

Returns:

the numbers of insert records successfully, if fails,return integer less than 0.

insertAndReturnId

<T> long insertAndReturnId(T entity)

According to entity object insert record and return id value.
Just support single primary key.If primary key empty or more one, will use "id".

Parameters:

entity - table's entity(do not allow null).
The entity corresponding to table and can not be null.
The not null and not empty field will insert to database.

Returns:

If successful, return the id value of the inserted record; if fails, return number less than 0.

Since:

1.9

delete

<T> int delete(T entity)

According to entity object delete record.

Parameters:

entity - table's entity(do not allow null).
The entity corresponding to table and can not be null.
If the field value is not null and not empty field as filter condition,
the operator is equal sign.eg:field=value

Returns:

the numbers of delete records successfully, if fails,return integer less than 0.

delete

<T> int delete(T entity,
               Condition condition)

Delete the records according to entity and condition.

Parameters:

entity - table's entity(do not allow null).

condition - If the field of entity is not null or empty, it will be translate to field=value.Other can define with condition.

Returns:

the number of deleted record(s) successfully, if fails,return integer less than 0.

Since:

1.7.2

update

<T> int update(T entity,
               String... updateFields)

Update record, can list update fields.

Parameters:

entity - table's entity(do not allow null).

updateFields - update fields.
For the list of fields to be updated, multiple fields can separated by commas in one updateField parameter
or use variable parameter (those fields will be updated).
This attribute cannot be empty and is not affected by the includeType parameter; By default, each field will be
converted to a set expression of SQL update.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

update

<T> int update(T entity,
               IncludeType includeType,
               String... updateFields)

Update record according to entity.

Parameters:

entity - table's entity(do not allow null).if id's value is null can not as filter condition.

includeType - whether null string and null as a filter conditions.

updateFields - update fields.
For the list of fields to be updated, multiple fields can separated by commas in one updateField parameter or
use variable parameter (those fields will be updated).
This attribute cannot be empty and is not affected by the includeType parameter; By default, each field will be
converted to a set expression of SQL update.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

2.0

insert

<T> int insert(T[] entity)

Insert records by batch type.

Parameters:

entity - table's entity array(do not allow null).

Returns:

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

insert

<T> int insert(T[] entity,
               int batchSize)

Insert records by batch type.

Parameters:

entity - table's entity array(do not allow null).

batchSize - batch size.

Returns:

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

insert

<T> int insert(T[] entity,
               String excludeFields)

Insert record by batch type,and can point out which field(s) don't need to insert.

Parameters:

entity - table's entity array(do not allow null).

excludeFields - fields list that don't need to insert .

Returns:

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

insert

<T> int insert(T[] entity,
               int batchSize,
               String excludeFields)

Insert record by batch type,and can point out which field(s) don't need to insert.

Parameters:

entity - table's entity array(do not allow null).

batchSize - batch size.

excludeFields - Don't insert fields list.

Returns:

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

insert

<T> int insert(List<T> entityList)

Insert records by batch type.

Parameters:

entityList - table's entity list(do not allow null).

Returns:

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

Since:

1.9

insert

<T> int insert(List<T> entityList,
               int batchSize)

Insert records by batch type.

Parameters:

entityList - table's entity list(do not allow null).

batchSize - batch size.

Returns:

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

Since:

1.9

insert

<T> int insert(List<T> entityList,
               String excludeFields)

Insert record by batch type,and can point out which field(s) don't need to insert.

Parameters:

entityList - table's entity list(do not allow null).

excludeFields - fields list that don't need to insert.

Returns:

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

Since:

1.9

insert

<T> int insert(List<T> entityList,
               int batchSize,
               String excludeFields)

Insert record by batch type,and can point out which field(s) don't need to insert.

Parameters:

entityList - table's entity list(do not allow null).

batchSize - batch size.

excludeFields - Don't insert fields list.

Returns:

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

Since:

1.9

update

<T> int update(T entity,
               IncludeType includeType)

Update record according to entity by primary key.

Parameters:

entity - table's entity(do not allow null),The id field in entity cannot be empty as a filtering condition.

includeType - whether null string and null as a filter conditions.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

insert

<T> int insert(T entity,
               IncludeType includeType)

Insert record according to entity.

Parameters:

entity - table's entity(do not allow null).

includeType - whether null string and null as a filter conditions.

Returns:

the number of inserted record(s) successfully,if fails, return integer less than 0.

insertAndReturnId

<T> long insertAndReturnId(T entity,
                           IncludeType includeType)

According to entity object insert record and return id value.
Just support single primary key.If primary key empty or more one, will use "id".

Parameters:

entity - table's entity(do not allow null).
The entity corresponding to table and can not be null.
The not null and not empty field will insert to database.

includeType - whether null string and null as a filter conditions.

Returns:

If successful, return the id value of the inserted record; if fails, return number less than 0.

Since:

V1.11

deleteById

int deleteById(Class<?> c,
               Integer id)

Delete record by id.

Parameters:

c - table's entity class(do not allow null).

id - value of entity's id field.

Returns:

the number of deleted record(s) successfully,if fails, return integer less than 0.

Since:

1.4

deleteById

int deleteById(Class<?> c,
               Long id)

Delete record by id.

Parameters:

c - table's entity class(do not allow null).

id - value of entity's id field.

Returns:

the number of deleted record(s) successfully,if fails, return integer less than 0.

Since:

1.4

deleteById

int deleteById(Class<?> c,
               String ids)

Delete record by id.

Parameters:

c - table's entity class(do not allow null).

ids - ids values of entity's id field,if more than one,separate with comma.

Returns:

the number of deleted record(s) successfully,if fails, return integer less than 0.

Since:

1.4

updateBy

<T> int updateBy(T entity,
                 String... whereFields)

Update record according to whereFields.

Parameters:

entity - table's entity(do not allow null).
Fields that are not specified as whereFields, as part of the set(only non empty and non null fields
are processed by default).

whereFields - As a field list of where part in SQL, multiple fields can separated by commas in one
whereField parameter or use variable parameter (the fields in the list will be used as where filter)
But if id's value is null can not as filter.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

1.6

updateBy

<T> int updateBy(T entity,
                 IncludeType includeType,
                 String... whereFields)

Update record according to whereFields.

Parameters:

entity - table's entity(do not allow null).
Fields that are not specified as whereFields, as part of the set(only non empty and non null
fields are processed by default,can change the default use IncludeType parameter).

includeType - whether null string and null as a filter conditions.

whereFields - As a field list of where part in SQL, multiple fields can separated by commas in one
whereField parameter or use variable parameter (the fields in the list will be used as where filter)
But if id's value is null can not as filter.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

2.0

updateBy

<T> int updateBy(T entity,
                 Condition condition,
                 String... whereFields)

Update record according to whereFields.

Parameters:

entity - table's entity(do not allow null).
Fields that are not specified as whereFields, as part of the set(only non empty and non null fields
are processed by default).

condition - Condition as filter the record.

whereFields - As a field list of where part in SQL, multiple fields can separated by commas in one
whereField parameter or use variable parameter (the fields in the list will be used as where filter)
But if id's value is null can not as filter.
Notice:the method op of condition also maybe converted to the where expression.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

2.0

updateById

<T> int updateById(T entity,
                   Condition condition)

it is equivalent to updateBy(entity,"id",condition)

Parameters:

entity - table's entity(do not allow null).
In entity, except for the ID field, other fields are used as the set part (only non empty and non null fields are processed by default)

condition - Condition as filter the record.
It should be noted that the condition set by OP may also be converted to the filter condition of where.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

1.9

update

<T> int update(T entity,
               Condition condition,
               String... updateFields)

Update record, can list update fields.

Parameters:

entity - table's entity(do not allow null).
If the field of entity is not null or empty, it will be translate to field=value.Other can define with condition.

condition - Condition as filter the record.
A field is used not only in the specified updateFields, but also in Condition.set(arg1,arg2),
and the corresponding fields in entity will be converted to the where part according to the rules (V1.9.8)

updateFields - update fields.The methods setMultiply,setAdd,set in condition are not subject to this restriction.
For the list of fields to be updated, multiple fields can separated by commas in one updateField parameter or use
variable parameter (those fields will be updated).
This attribute cannot be empty and is not affected by the Condition's includeType parameter. By default, each
field will be converted to a set expression of SQL update.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

2.0

update

<T> int update(T entity,
               Condition condition)

Update record,and can help with Condition.
When the set expression of SQL update is defined by Condition, you can no longer specify the field used by set.
it is equivalent to update(entity,"",condition),updateFields value is "".

Parameters:

entity - table's entity(do not allow null).
If the field of entity is not null or empty, it will be translate to field=value in where part.Other can define with condition.

condition - Condition as filter the record.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

1.8

update

<T> int update(T oldEntity,
               T newEntity)

Update the entity. The non null and non empty attributes of oldEntity are taken as
the filtering conditions; The non null and non empty properties of newEntity are
used as the corresponding values of the properties to be updated
Old and new entities must be of the same type.
oldEntity is converted to Where part of SQL, and newEntity is converted to Set part.
The object-oriented Interceptor only processes the newEntity;
The oldEntity as conditions is not processed in the Interceptor.

Parameters:

oldEntity - Entity with old value field.

newEntity - Entity with new value field.some fields(serialVersionUID,have annotation JoinTable or Ignore, value is null) would be ignored.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

save

<T> int save(T entity)

save one entity(one record).
If it can be distinguished, it is recommended to explicitly call insert (entity)
or update (entity), which is more secure and efficient.

Parameters:

entity -

Returns:

the numbers of effect record(s),if fails, return integer less than 0.

Since:

1.9.8

createTable

<T> boolean createTable(Class<T> entityClass,
                        boolean isDropExistTable)

According to the database table generated by JavaBean, JavaBean does not need to configure
too much field information. This method only considers the general situation, and is not
recommended if there are detailed requirements.

Parameters:

entityClass - table's entityClass(do not allow null).

isDropExistTable - whether drop the exist table before create

Returns:

flag whether create successfully.

Since:

2.1

indexNormal

<T> void indexNormal(Class<T> entityClass,
                     String fields,
                     String indexName)

create normal index

Parameters:

entityClass -

fields -

indexName -

Since:

2.1

unique

<T> void unique(Class<T> entityClass,
                String fields,
                String indexName)

create unique index

Parameters:

entityClass -

fields -

indexName -

Since:

2.1

primaryKey

<T> void primaryKey(Class<T> entityClass,
                    String fields,
                    String keyName)

create primaryKey index

Parameters:

entityClass -

fields -

keyName -

Since:

2.1

dropIndex

<T> void dropIndex(Class<T> entityClass,
                   String indexName)

drop index

Parameters:

entityClass -

indexName -

Since:

2.1

beginSameConnection

void beginSameConnection()

declare begin Same Connection for some ORM operation.

Since:

1.9

endSameConnection

void endSameConnection()

declare end Same Connection for some ORM operation.

Since:

1.9