PinusClient (pinus-orm 1.2.0 API)

All Known Implementing Classes:

DefaultPinusClient
```
public interface PinusClient
```
main api of pinus.

Author:

duanbn

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`beginTransaction()` default transaction isolation level is read_commited
`void`	`beginTransaction(EnumTransactionIsolationLevel txLevel)`
`void`	`commit()`
`Lock`	`createLock(String lockName)` 创建一个分布式锁.
`<T> IQuery<T>`	`createQuery(Class<T> clazz)`
`void`	`delete(List<? extends Object> entityList)`
`void`	`delete(Object entity)`
`void`	`destroy()` 关闭存储.
`List<Map<String,Object>>`	`findBySQL(SQL sql, Class<?> clazz)` Deprecated.
`List<Map<String,Object>>`	`findBySQL(SQL sql, String clusterName)`
`void`	`flush()` do commit but don't close db connection.
`int`	`genClusterUniqueIntId(String name)` 生成全局唯一的int id.
`int[]`	`genClusterUniqueIntIdBatch(String name, int batchSize)` 批量生成全局唯一主键.
`long`	`genClusterUniqueLongId(String name)` 生成全局唯一的long id.
`long[]`	`genClusterUniqueLongIdBatch(String name, int batchSize)` 批量生成全局唯一主键.
`IDBCluster`	`getDBCluster()` /** 获取当前使用的数据库集群.
`IPrimaryCache`	`getPrimaryCache()` 获取一级缓存控制接口
`ISecondCache`	`getSecondCache()` 获取二级缓存控制接口
`void`	`init()` 初始化集群客户端.
`void`	`load(Object entity)`
`void`	`load(Object entity, boolean useCache)`
`void`	`load(Object entity, boolean useCache, EnumDBMasterSlave masterSlave)`
`void`	`load(Object entity, EnumDBMasterSlave masterSlave)`
`void`	`rollback()`
`void`	`save(Object entity)` 保存单个数据对象.
`void`	`saveBatch(List<? extends Object> entityList)` 批量保存数据，获取自增主键.
`void`	`saveBatch(List<? extends Object> entityList, boolean autoGeneratedKeys)` 保存批量数据对象.
`void`	`setScanPackage(String scanPackage)` 设置扫描的实体对象包.
`void`	`setSyncAction(EnumSyncAction syncAction)` 设置数据表同步动作.
`<T> TaskFuture`	`submit(ITask<T> task, Class<T> clazz)` 提交一个数据处理任务.
`<T> TaskFuture`	`submit(ITask<T> task, Class<T> clazz, IQuery<T> query)` 提交一个数据处理任务.
`void`	`update(Object entity)`
`void`	`updateBatch(List<? extends Object> entityList)`

- Method Detail
  - beginTransaction
```
void beginTransaction()
```
    default transaction isolation level is read_commited
  - beginTransaction
```
void beginTransaction(EnumTransactionIsolationLevel txLevel)
```
  - commit
```
void commit()
```
  - rollback
```
void rollback()
```
  - flush
```
void flush()
```
    do commit but don't close db connection.
  - submit
```
<T> TaskFuture submit(ITask<T> task,
                    Class<T> clazz)
```
    提交一个数据处理任务.
    
    Parameters:
    task - 处理任务
    clazz - 数据对象的Class
    
    Returns:
  - submit
```
<T> TaskFuture submit(ITask<T> task,
                    Class<T> clazz,
                    IQuery<T> query)
```
    提交一个数据处理任务. 可以设置一个查询条件，只处理符合查询条件的数据
    
    Parameters:
    task - 处理任务
    clazz - 数据对象的Class
    query - 查询条件
    
    Returns:
  - save
```
void save(Object entity)
```
    保存单个数据对象.
    
    Parameters:
    entity - 被@Table标注的数据对象
  - saveBatch
```
void saveBatch(List<? extends Object> entityList)
```
    批量保存数据，获取自增主键.
    
    Parameters:
    entityList -
  - saveBatch
```
void saveBatch(List<? extends Object> entityList,
             boolean autoGeneratedKeys)
```
    保存批量数据对象. 如果不获取自增主键则会大幅提高保存性能.
    实体必须是具备唯一自增主键
    
    Parameters:
    entityList -
    autoGeneratedKeys - 是否获取自增主键值.
  - update
```
void update(Object entity)
```
  - updateBatch
```
void updateBatch(List<? extends Object> entityList)
```
  - delete
```
void delete(Object entity)
```
  - delete
```
void delete(List<? extends Object> entityList)
```
  - load
```
void load(Object entity)
```
  - load
```
void load(Object entity,
        boolean useCache)
```
  - load
```
void load(Object entity,
        EnumDBMasterSlave masterSlave)
```
  - load
```
void load(Object entity,
        boolean useCache,
        EnumDBMasterSlave masterSlave)
```
  - createQuery
```
<T> IQuery<T> createQuery(Class<T> clazz)
```
  - findBySQL
```
@Deprecated
List<Map<String,Object>> findBySQL(SQL sql,
                                            Class<?> clazz)
```
    Deprecated.
  - findBySQL
```
List<Map<String,Object>> findBySQL(SQL sql,
                                 String clusterName)
```
  - createLock
```
Lock createLock(String lockName)
```
    创建一个分布式锁.
    
    Parameters:
    lockName - 锁名称
    
    Returns:
  - getDBCluster
```
IDBCluster getDBCluster()
```
    /** 获取当前使用的数据库集群.
    
    Returns:
    数据库集群
  - getPrimaryCache
```
IPrimaryCache getPrimaryCache()
```
    获取一级缓存控制接口
    
    Returns:
  - getSecondCache
```
ISecondCache getSecondCache()
```
    获取二级缓存控制接口
    
    Returns:
  - genClusterUniqueIntId
```
int genClusterUniqueIntId(String name)
```
    生成全局唯一的int id. 对一个数据对象的集群全局唯一id.
    
    Parameters:
    name -
    
    Returns:
    单个数据对象的集群全局唯一id
    
    Throws:
    
    DBOperationException - 生成id失败
  - genClusterUniqueLongId
```
long genClusterUniqueLongId(String name)
```
    生成全局唯一的long id. 对一个数据对象的集群全局唯一id.
    
    Parameters:
    clusterName - 数据库集群名
    clazz - 数据对象class
    
    Returns:
    单个数据对象的集群全局唯一id
    
    Throws:
    
    DBOperationException - 生成id失败
  - genClusterUniqueLongIdBatch
```
long[] genClusterUniqueLongIdBatch(String name,
                                 int batchSize)
```
    批量生成全局唯一主键.
    
    Parameters:
    clusterName - 数据库集群名
    clazz - 数据对象class
    batchSize - 批量数
  - genClusterUniqueIntIdBatch
```
int[] genClusterUniqueIntIdBatch(String name,
                               int batchSize)
```
    批量生成全局唯一主键.
    
    Parameters:
    clusterName - 数据库集群名
    clazz - 数据对象class
    batchSize - 批量数
  - init
```
void init()
          throws LoadConfigException
```
    初始化集群客户端.
    
    Throws:
    
    LoadConfigException
  - destroy
```
void destroy()
```
    关闭存储.
  - setSyncAction
```
void setSyncAction(EnumSyncAction syncAction)
```
    设置数据表同步动作.
    
    Parameters:
    syncAction -
  - setScanPackage
```
void setScanPackage(String scanPackage)
```
    设置扫描的实体对象包. 用户加载分表信息和自动创建数据表.
    
    Parameters:
    scanPackage -

Interface PinusClient

Method Summary

Method Detail

beginTransaction

beginTransaction

commit

rollback

flush

submit

submit

save

saveBatch

saveBatch

update

updateBatch

delete

delete

load

load

load

load

createQuery

findBySQL

findBySQL

createLock

getDBCluster

getPrimaryCache

getSecondCache

genClusterUniqueIntId

genClusterUniqueLongId

genClusterUniqueLongIdBatch

genClusterUniqueIntIdBatch

init

destroy

setSyncAction

setScanPackage