DefaultPinusClient (pinus-orm 1.2.0 API)

java.lang.Object
- org.pinus4j.api.DefaultPinusClient

All Implemented Interfaces:

PinusClient
```
public class DefaultPinusClient
extends Object
implements PinusClient
```
default main api implement.

Author:

duanbn

Field Summary

Fields
Modifier and Type	Field and Description
`private IDBCluster`	`dbCluster` ref of db cluster.
`private IEntityMetaManager`	`entityMetaManager`
`private EnumDB`	`enumDb` 数据库类型.
`private IGlobalQuery`	`globalQuery` global query.
`private IGlobalUpdate`	`globalUpdater` global updater.
`private IIdGenerator`	`idGenerator` id generator.
`static PinusClient`	`instance` reference it self;
`static org.slf4j.Logger`	`LOG` 日志.
`private String`	`scanPackage` 扫描数据对象的包.
`private IShardingQuery`	`shardingQuery` sharding query.
`private IShardingUpdate`	`shardingUpdater` 分库分表更新实现.
`private EnumSyncAction`	`syncAction` 同步数据表操作.
`private TransactionManager`	`txManager` transaction manager.

Constructor Summary

Constructors
Constructor and Description

DefaultPinusClient()

Constructors
Constructor and Description
`DefaultPinusClient()`

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)`
`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()` 获取一级缓存控制接口
`String`	`getScanPackage()`
`ISecondCache`	`getSecondCache()` 获取二级缓存控制接口
`EnumSyncAction`	`getSyncAction()`
`void`	`init()` init method
`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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
public static final org.slf4j.Logger LOG
```
    日志.
  - instance
```
public static PinusClient instance
```
    reference it self;
  - enumDb
```
private EnumDB enumDb
```
    数据库类型.
  - syncAction
```
private EnumSyncAction syncAction
```
    同步数据表操作.
  - scanPackage
```
private String scanPackage
```
    扫描数据对象的包. 数据对象是使用了@Table注解的javabean.
  - idGenerator
```
private IIdGenerator idGenerator
```
    id generator.
  - dbCluster
```
private IDBCluster dbCluster
```
    ref of db cluster.
  - txManager
```
private TransactionManager txManager
```
    transaction manager.
  - globalUpdater
```
private IGlobalUpdate globalUpdater
```
    global updater.
  - globalQuery
```
private IGlobalQuery globalQuery
```
    global query.
  - shardingUpdater
```
private IShardingUpdate shardingUpdater
```
    分库分表更新实现.
  - shardingQuery
```
private IShardingQuery shardingQuery
```
    sharding query.
  - entityMetaManager
```
private IEntityMetaManager entityMetaManager
```
- Constructor Detail
  - DefaultPinusClient
```
public DefaultPinusClient()
```
- Method Detail
  - init
```
public void init()
```
    init method
    
    Specified by:
    
    init in interface PinusClient
  - destroy
```
public void destroy()
```
    Description copied from interface: PinusClient
    
    关闭存储.
    
    Specified by:
    
    destroy in interface PinusClient
  - beginTransaction
```
public void beginTransaction()
```
    Description copied from interface: PinusClient
    
    default transaction isolation level is read_commited
    
    Specified by:
    
    beginTransaction in interface PinusClient
  - beginTransaction
```
public void beginTransaction(EnumTransactionIsolationLevel txLevel)
```
    Specified by:
    
    beginTransaction in interface PinusClient
  - commit
```
public void commit()
```
    Specified by:
    
    commit in interface PinusClient
  - rollback
```
public void rollback()
```
    Specified by:
    
    rollback in interface PinusClient
  - flush
```
public void flush()
```
    Description copied from interface: PinusClient
    
    do commit but don't close db connection.
    
    Specified by:
    
    flush in interface PinusClient
  - submit
```
public <T> TaskFuture submit(ITask<T> task,
                    Class<T> clazz)
```
    Description copied from interface: PinusClient
    
    提交一个数据处理任务.
    
    Specified by:
    
    submit in interface PinusClient
    
    Parameters:
    task - 处理任务
    clazz - 数据对象的Class
    
    Returns:
  - submit
```
public <T> TaskFuture submit(ITask<T> task,
                    Class<T> clazz,
                    IQuery<T> query)
```
    Description copied from interface: PinusClient
    
    提交一个数据处理任务. 可以设置一个查询条件，只处理符合查询条件的数据
    
    Specified by:
    
    submit in interface PinusClient
    
    Parameters:
    task - 处理任务
    clazz - 数据对象的Class
    query - 查询条件
    
    Returns:
  - save
```
public void save(Object entity)
```
    Description copied from interface: PinusClient
    
    保存单个数据对象.
    
    Specified by:
    
    save in interface PinusClient
    
    Parameters:
    entity - 被@Table标注的数据对象
  - saveBatch
```
public void saveBatch(List<? extends Object> entityList)
```
    Description copied from interface: PinusClient
    
    批量保存数据，获取自增主键.
    
    Specified by:
    
    saveBatch in interface PinusClient
  - saveBatch
```
public void saveBatch(List<? extends Object> entityList,
             boolean autoGeneratedKeys)
```
    Description copied from interface: PinusClient
    
    保存批量数据对象. 如果不获取自增主键则会大幅提高保存性能.
    实体必须是具备唯一自增主键
    
    Specified by:
    
    saveBatch in interface PinusClient
    
    autoGeneratedKeys - 是否获取自增主键值.
  - update
```
public void update(Object entity)
```
    Specified by:
    
    update in interface PinusClient
  - updateBatch
```
public void updateBatch(List<? extends Object> entityList)
```
    Specified by:
    
    updateBatch in interface PinusClient
  - delete
```
public void delete(Object entity)
```
    Specified by:
    
    delete in interface PinusClient
  - delete
```
public void delete(List<? extends Object> entityList)
```
    Specified by:
    
    delete in interface PinusClient
  - load
```
public void load(Object entity)
```
    Specified by:
    
    load in interface PinusClient
  - load
```
public void load(Object entity,
        boolean useCache)
```
    Specified by:
    
    load in interface PinusClient
  - load
```
public void load(Object entity,
        EnumDBMasterSlave masterSlave)
```
    Specified by:
    
    load in interface PinusClient
  - load
```
public void load(Object entity,
        boolean useCache,
        EnumDBMasterSlave masterSlave)
```
    Specified by:
    
    load in interface PinusClient
  - createQuery
```
public <T> IQuery<T> createQuery(Class<T> clazz)
```
    Specified by:
    
    createQuery in interface PinusClient
  - findBySQL
```
public List<Map<String,Object>> findBySQL(SQL sql,
                                 Class<?> clazz)
```
    Specified by:
    
    findBySQL in interface PinusClient
  - findBySQL
```
public List<Map<String,Object>> findBySQL(SQL sql,
                                 String clusterName)
```
    Specified by:
    
    findBySQL in interface PinusClient
  - getDBCluster
```
public IDBCluster getDBCluster()
```
    Description copied from interface: PinusClient
    
    /** 获取当前使用的数据库集群.
    
    Specified by:
    
    getDBCluster in interface PinusClient
    
    Returns:
    数据库集群
  - getPrimaryCache
```
public IPrimaryCache getPrimaryCache()
```
    Description copied from interface: PinusClient
    
    获取一级缓存控制接口
    
    Specified by:
    
    getPrimaryCache in interface PinusClient
    
    Returns:
  - getSecondCache
```
public ISecondCache getSecondCache()
```
    Description copied from interface: PinusClient
    
    获取二级缓存控制接口
    
    Specified by:
    
    getSecondCache in interface PinusClient
    
    Returns:
  - genClusterUniqueIntId
```
public int genClusterUniqueIntId(String name)
```
    Description copied from interface: PinusClient
    
    生成全局唯一的int id. 对一个数据对象的集群全局唯一id.
    
    Specified by:
    
    genClusterUniqueIntId in interface PinusClient
    
    Returns:
    单个数据对象的集群全局唯一id
  - genClusterUniqueLongId
```
public long genClusterUniqueLongId(String name)
```
    Description copied from interface: PinusClient
    
    生成全局唯一的long id. 对一个数据对象的集群全局唯一id.
    
    Specified by:
    
    genClusterUniqueLongId in interface PinusClient
    
    Returns:
    单个数据对象的集群全局唯一id
  - genClusterUniqueLongIdBatch
```
public long[] genClusterUniqueLongIdBatch(String name,
                                 int batchSize)
```
    Description copied from interface: PinusClient
    
    批量生成全局唯一主键.
    
    Specified by:
    
    genClusterUniqueLongIdBatch in interface PinusClient
    
    batchSize - 批量数
  - genClusterUniqueIntIdBatch
```
public int[] genClusterUniqueIntIdBatch(String name,
                               int batchSize)
```
    Description copied from interface: PinusClient
    
    批量生成全局唯一主键.
    
    Specified by:
    
    genClusterUniqueIntIdBatch in interface PinusClient
    
    batchSize - 批量数
  - createLock
```
public Lock createLock(String lockName)
```
    Description copied from interface: PinusClient
    
    创建一个分布式锁.
    
    Specified by:
    
    createLock in interface PinusClient
    
    Parameters:
    lockName - 锁名称
    
    Returns:
  - getSyncAction
```
public EnumSyncAction getSyncAction()
```
  - setSyncAction
```
public void setSyncAction(EnumSyncAction syncAction)
```
    Description copied from interface: PinusClient
    
    设置数据表同步动作.
    
    Specified by:
    
    setSyncAction in interface PinusClient
  - getScanPackage
```
public String getScanPackage()
```
  - setScanPackage
```
public void setScanPackage(String scanPackage)
```
    Description copied from interface: PinusClient
    
    设置扫描的实体对象包. 用户加载分表信息和自动创建数据表.
    
    Specified by:
    
    setScanPackage in interface PinusClient

Class DefaultPinusClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

instance

enumDb

syncAction

scanPackage

idGenerator

dbCluster

txManager

globalUpdater

globalQuery

shardingUpdater

shardingQuery

entityMetaManager

Constructor Detail

DefaultPinusClient

Method Detail

init

destroy

beginTransaction

beginTransaction

commit

rollback

flush

submit

submit

save

saveBatch

saveBatch

update

updateBatch

delete

delete

load

load

load

load

createQuery

findBySQL

findBySQL

getDBCluster

getPrimaryCache

getSecondCache

genClusterUniqueIntId

genClusterUniqueLongId

genClusterUniqueLongIdBatch

genClusterUniqueIntIdBatch

createLock

getSyncAction

setSyncAction

getScanPackage

setScanPackage