org.pinus4j.api

Interface IShardingStorageClient

All Known Implementing Classes:

ShardingStorageClientImpl

public interface IShardingStorageClient

Pinus存储中间件用户调用接口. 所有分布式存储的操作都有此接口提供.

Author:

duanbn

Method Summary

Modifier and Type	Method and Description
Lock	createLock(String lockName) 创建一个分布式锁.
IQuery	createQuery() 创建一个查询条件对象.
void	destroy() 关闭存储.
<T> T	findByPk(Number pk, IShardingKey<?> shardingKey, Class<T> clazz) 一个主分库分表, 根据主键查询.
<T> T	findByPk(Number pk, IShardingKey<?> shardingKey, Class<T> clazz, boolean useCache)
<T> T	findByPk(Number pk, IShardingKey<?> shardingKey, Class<T> clazz, boolean useCache, EnumDBMasterSlave masterSlave)
<T> T	findByPk(Number pk, IShardingKey<?> shardingKey, Class<T> clazz, EnumDBMasterSlave masterSlave) 一个主分库分表, 根据主键查询.
<T> List<T>	findByPkList(List<? extends Number> pks, IShardingKey<?> shardingKey, Class<T> clazz) 一个主分库分表, 根据多个主键查询.当查询不到数据时返回空的List，不会返回null.
<T> List<T>	findByPkList(List<? extends Number> pks, IShardingKey<?> shardingKey, Class<T> clazz, boolean useCache)
<T> List<T>	findByPkList(List<? extends Number> pks, IShardingKey<?> shardingKey, Class<T> clazz, boolean useCache, EnumDBMasterSlave masterSlave)
<T> List<T>	findByPkList(List<? extends Number> pks, IShardingKey<?> shardingKey, Class<T> clazz, EnumDBMasterSlave masterSlave) 一个主分库分表, 根据多个主键查询.当查询不到数据时返回空的List，不会返回null.
<T> List<T>	findByPks(IShardingKey<?> shardingKey, Class<T> clazz, boolean useCache, Number... pks)
<T> List<T>	findByPks(IShardingKey<?> shardingKey, Class<T> clazz, EnumDBMasterSlave masterSlave, boolean useCache, Number... pks)
<T> List<T>	findByPks(IShardingKey<?> shardingKey, Class<T> clazz, EnumDBMasterSlave masterSlave, Number... pks) 一个主分库分表, 根据多个主键查询.当查询不到数据时返回空的List，不会返回null.
<T> List<T>	findByPks(IShardingKey<?> shardingKey, Class<T> clazz, Number... pks) 一个主分库分表, 根据多个主键查询.当查询不到数据时返回空的List，不会返回null.
<T> List<T>	findByQuery(IQuery query, IShardingKey<?> shardingKey, Class<T> clazz) 根据查询条件对象进行查询.当查询不到数据时返回空的List，不会返回null.
<T> List<T>	findByQuery(IQuery query, IShardingKey<?> shardingKey, Class<T> clazz, boolean useCache)
<T> List<T>	findByQuery(IQuery query, IShardingKey<?> shardingKey, Class<T> clazz, boolean useCache, EnumDBMasterSlave masterSlave)
<T> List<T>	findByQuery(IQuery query, IShardingKey<?> shardingKey, Class<T> clazz, EnumDBMasterSlave masterSlave) 根据查询条件对象进行查询.当查询不到数据时返回空的List，不会返回null.
List<Map<String,Object>>	findBySql(SQL sql, IShardingKey<?> shardingKey) 一个主分库分表, 根据条件查询.当查询不到数据时返回空的List，不会返回null.
List<Map<String,Object>>	findBySql(SQL sql, IShardingKey<?> shardingKey, EnumDBMasterSlave masterSlave) 一个主分库分表, 根据条件查询.当查询不到数据时返回空的List，不会返回null.
<T> T	findGlobalByPk(Number pk, String clusterName, Class<T> clazz) 根据pk查询全局表中的数据.
<T> T	findGlobalByPk(Number pk, String clusterName, Class<T> clazz, boolean useCache)
<T> T	findGlobalByPk(Number pk, String clusterName, Class<T> clazz, boolean useCache, EnumDBMasterSlave masterSlave)
<T> T	findGlobalByPk(Number pk, String clusterName, Class<T> clazz, EnumDBMasterSlave masterSlave) 根据pk查询全局表中的数据.
<T> List<T>	findGlobalByPkList(List<? extends Number> pks, String clusterName, Class<T> clazz) 根据主键查询全局表数据.
<T> List<T>	findGlobalByPkList(List<? extends Number> pks, String clusterName, Class<T> clazz, boolean useCache)
<T> List<T>	findGlobalByPkList(List<? extends Number> pks, String clusterName, Class<T> clazz, boolean useCache, EnumDBMasterSlave masterSlave)
<T> List<T>	findGlobalByPkList(List<? extends Number> pks, String clusterName, Class<T> clazz, EnumDBMasterSlave masterSlave) 根据主键查询全局表数据.
<T> List<T>	findGlobalByPks(String clusterName, Class<T> clazz, boolean useCache, Number... pks)
<T> List<T>	findGlobalByPks(String clusterName, Class<T> clazz, EnumDBMasterSlave masterSlave, boolean useCache, Number... pks)
<T> List<T>	findGlobalByPks(String clusterName, Class<T> clazz, EnumDBMasterSlave masterSlave, Number... pks) 根据主键查询全局表数据.
<T> List<T>	findGlobalByPks(String clusterName, Class<T> clazz, Number... pks) 根据主键查询全局表数据.
<T> List<T>	findGlobalByQuery(IQuery query, String clusterName, Class<T> clazz) 根据Query查询全局表.
<T> List<T>	findGlobalByQuery(IQuery query, String clusterName, Class<T> clazz, boolean useCache)
<T> List<T>	findGlobalByQuery(IQuery query, String clusterName, Class<T> clazz, boolean useCache, EnumDBMasterSlave masterSlave)
<T> List<T>	findGlobalByQuery(IQuery query, String clusterName, Class<T> clazz, EnumDBMasterSlave masterSlave) 根据Query查询全局表.
List<Map<String,Object>>	findGlobalBySql(SQL sql, String clusterName) 根据sql查询全局表.
List<Map<String,Object>>	findGlobalBySql(SQL sql, String clusterName, EnumDBMasterSlave masterSlave) 根据sql查询全局表.
<T> T	findGlobalOneByQuery(IQuery query, String clusterName, Class<T> clazz) 根据Query对象查询全局表数据.
<T> T	findGlobalOneByQuery(IQuery query, String clusterName, Class<T> clazz, boolean useCache)
<T> T	findGlobalOneByQuery(IQuery query, String clusterName, Class<T> clazz, boolean useCache, EnumDBMasterSlave masterSlave)
<T> T	findGlobalOneByQuery(IQuery query, String clusterName, Class<T> clazz, EnumDBMasterSlave masterSlave) 根据Query对象查询全局表数据.
<T> T	findOneByQuery(IQuery query, IShardingKey<?> shardingKey, Class<T> clazz) 根据查询条件获取一条数据.
<T> T	findOneByQuery(IQuery query, IShardingKey<?> shardingKey, Class<T> clazz, boolean useCache)
<T> T	findOneByQuery(IQuery query, IShardingKey<?> shardingKey, Class<T> clazz, boolean useCache, EnumDBMasterSlave masterSlave)
<T> T	findOneByQuery(IQuery query, IShardingKey<?> shardingKey, Class<T> clazz, EnumDBMasterSlave masterSlave) 根据查询条件获取一条数据.
int	genClusterUniqueIntId(String name) 生成全局唯一的int id.
int[]	genClusterUniqueIntIdBatch(String name, int batchSize) 批量生成全局唯一主键.
long	genClusterUniqueLongId(String name) 生成全局唯一的long id.
long[]	genClusterUniqueLongIdBatch(String name, int batchSize) 批量生成全局唯一主键.
Number	getCount(Class<?> clazz) 获取分片实体的集群总数.
Number	getCount(Class<?> clazz, boolean useCache)
Number	getCount(Class<?> clazz, IQuery query) 根据查询条件获取记录.
Number	getCount(IQuery query, IShardingKey<?> shardingKey, Class<?> clazz) 根据查询条件获取某个分库分表的记录数.
Number	getCount(IShardingKey<?> shardingKey, Class<?> clazz) 获取分库分表记录总数.
Number	getCount(IShardingKey<?> shardingKey, Class<?> clazz, boolean useCache)
IDBCluster	getDbCluster() 获取当前使用的数据库集群.
Number	getGlobalCount(IQuery query, String clusterName, Class<?> clazz) 根据条件查询全局表的数量.
Number	getGlobalCount(IQuery query, String clusterName, Class<?> clazz, boolean useCache, EnumDBMasterSlave masterSlave)
Number	getGlobalCount(IQuery query, String clusterName, Class<?> clazz, EnumDBMasterSlave masterSlave) 根据条件查询全局表的数量.
Number	getGlobalCount(String clusterName, Class<?> clazz) 查询全局库表的数量.
Number	getGlobalCount(String clusterName, Class<?> clazz, boolean useCache)
Number	getGlobalCount(String clusterName, Class<?> clazz, boolean useCache, EnumDBMasterSlave masterSlave)
Number	getGlobalCount(String clusterName, Class<?> clazz, EnumDBMasterSlave masterSlave) 查询全局库表的数量.
IIdGenerator	getIdGenerator() 获取ID生成器
void	globalRemoveByPk(Number pk, Class<?> clazz, String clusterName) 删除全局库
void	globalRemoveByPkList(List<? extends Number> pks, Class<?> clazz, String clusterName) 批量删除全局库
void	globalRemoveByPks(String clusterName, Class<?> clazz, Number... pks) 根据主键删除全局库中的记录.
Number	globalSave(Object entity) 保存数据到全局表.
Number[]	globalSaveBatch(List<? extends Object> entities, String clusterName) 批量保存数据到全局库.
void	globalUpdate(Object entity) 更新全局表数据.
void	globalUpdateBatch(List<? extends Object> entities, String clusterName) 批量更新全局库
void	init() 初始化集群客户端.
void	removeByPk(Number pk, IShardingKey<?> shardingKey, Class<?> clazz) 根据主键删除数据.
void	removeByPkList(List<? extends Number> pks, IShardingKey<?> shardingKey, Class<?> clazz) 根据主键批量删除数据.
void	removeByPks(IShardingKey<?> shardingKey, Class<?> clazz, Number... pks) 根据主键删除数据.
Number	save(Object entity) 保存数据到分库分表.
Number[]	saveBatch(List<? extends Object> entities, IShardingKey<?> shardingKey) 批量保存数据.
void	setEnumDb(EnumDB enumDb) 设置存储使用的数据库.
void	setIdGenerator(IIdGenerator idGenerator) 设置ID生成器.
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 query) 提交一个数据处理任务.
void	update(Object entity) 更新分库分表数据.
void	updateBatch(List<? extends Object> entities, IShardingKey<?> shardingKey) 单数据库多数据批量更新.

Method Detail

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

提交一个数据处理任务. 可以设置一个查询条件，只处理符合查询条件的数据

Parameters:

task - 处理任务

clazz - 数据对象的Class

query - 查询条件

Returns:

globalSave

Number globalSave(Object entity)

保存数据到全局表.

Parameters:

entity - 数据对象

Returns:

新产生的主键

Throws:

DBOperationException - 操作失败

globalSaveBatch

Number[] globalSaveBatch(List<? extends Object> entities,
                         String clusterName)

批量保存数据到全局库.

Parameters:

entities - 批量数据对象

clusterName - 集群名

Returns:

主键

Throws:

DBOperationException - 操作失败

globalUpdate

void globalUpdate(Object entity)

更新全局表数据.

Parameters:

entity - 数据对象.

Throws:

DBOperationException - 操作失败

globalUpdateBatch

void globalUpdateBatch(List<? extends Object> entities,
                       String clusterName)

批量更新全局库

Parameters:

entities - 批量更新数据

clusterName - 集群名

Throws:

DBOperationException - 操作失败

globalRemoveByPk

void globalRemoveByPk(Number pk,
                      Class<?> clazz,
                      String clusterName)

删除全局库

Parameters:

pk -

shardingKey -

clazz -

globalRemoveByPkList

void globalRemoveByPkList(List<? extends Number> pks,
                          Class<?> clazz,
                          String clusterName)

批量删除全局库

Parameters:

pks -

shardingKey -

clazz -

globalRemoveByPks

void globalRemoveByPks(String clusterName,
                       Class<?> clazz,
                       Number... pks)

根据主键删除全局库中的记录.

Parameters:

clusterName - 集群名称

clazz - 数据对象

pks - 主键

save

Number save(Object entity)

保存数据到分库分表.

Parameters:

entity - 数据对象

Returns:

新产生的主键

Throws:

DBOperationException - 操作失败

saveBatch

Number[] saveBatch(List<? extends Object> entities,
                   IShardingKey<?> shardingKey)

批量保存数据.

Parameters:

entities - 批量数据对象

shardingKey - 分库分表因子

Returns:

主键

Throws:

DBOperationException - 操作失败

update

void update(Object entity)

更新分库分表数据. 会忽略更新null值和默认值

Parameters:

entity - 数据对象

Throws:

DBOperationException - 操作失败

updateBatch

void updateBatch(List<? extends Object> entities,
                 IShardingKey<?> shardingKey)

单数据库多数据批量更新. 会忽略更新null值和默认值

Parameters:

entities - 批量更新数据

shardingKey - 分库分表因子

Throws:

DBOperationException - 操作失败

removeByPk

void removeByPk(Number pk,
                IShardingKey<?> shardingKey,
                Class<?> clazz)

根据主键删除数据.

Parameters:

pk - 主键

shardingKey - 分库分表因子

clazz - 数据对象class

Throws:

DBOperationException - 操作失败

removeByPkList

void removeByPkList(List<? extends Number> pks,
                    IShardingKey<?> shardingKey,
                    Class<?> clazz)

根据主键批量删除数据.

Parameters:

pks - 主键

shardingKey - 分库分表因子

clazz - 数据对象class

Throws:

DBOperationException - 操作失败

removeByPks

void removeByPks(IShardingKey<?> shardingKey,
                 Class<?> clazz,
                 Number... pks)

根据主键删除数据.

Parameters:

shardingKey - 数据分片因子

clazz - 数据对象

pks - 主键

Throws:

DBOperationException - 操作失败

getGlobalCount

Number getGlobalCount(String clusterName,
                      Class<?> clazz)

查询全局库表的数量.

Parameters:

clusterName - 集群名

clazz - 表示全局表的实体对象

Returns:

count数

getGlobalCount

Number getGlobalCount(String clusterName,
                      Class<?> clazz,
                      boolean useCache)

getGlobalCount

Number getGlobalCount(String clusterName,
                      Class<?> clazz,
                      EnumDBMasterSlave masterSlave)

查询全局库表的数量.

Parameters:

clusterName - 集群名

clazz - 表示全局表的实体对象

masterSlave - 指定主库或者从库

Returns:

count数

getGlobalCount

Number getGlobalCount(String clusterName,
                      Class<?> clazz,
                      boolean useCache,
                      EnumDBMasterSlave masterSlave)

getGlobalCount

Number getGlobalCount(IQuery query,
                      String clusterName,
                      Class<?> clazz)

根据条件查询全局表的数量.

Parameters:

query - 查询条件

clusterName - 集群名

clazz - 实体对象.

Returns:

count数

getGlobalCount

Number getGlobalCount(IQuery query,
                      String clusterName,
                      Class<?> clazz,
                      boolean useCache,
                      EnumDBMasterSlave masterSlave)

getGlobalCount

Number getGlobalCount(IQuery query,
                      String clusterName,
                      Class<?> clazz,
                      EnumDBMasterSlave masterSlave)

根据条件查询全局表的数量.

Parameters:

query - 查询条件

clusterName - 集群名

clazz - 实体对象.

masterSlave - 指定主库或者从库

Returns:

count数

findGlobalByPk

<T> T findGlobalByPk(Number pk,
                     String clusterName,
                     Class<T> clazz)

根据pk查询全局表中的数据. 查询不到则返回null

Parameters:

pk - 主键

clusterName - 集群名

clazz - 实体对象

Returns:

数据

findGlobalByPk

<T> T findGlobalByPk(Number pk,
                     String clusterName,
                     Class<T> clazz,
                     boolean useCache)

findGlobalByPk

<T> T findGlobalByPk(Number pk,
                     String clusterName,
                     Class<T> clazz,
                     EnumDBMasterSlave masterSlave)

根据pk查询全局表中的数据. 查询不到则返回null

Parameters:

pk - 主键

clusterName - 集群名

clazz - 实体对象

masterSlave - 指定主库或者从库

Returns:

数据

findGlobalByPk

<T> T findGlobalByPk(Number pk,
                     String clusterName,
                     Class<T> clazz,
                     boolean useCache,
                     EnumDBMasterSlave masterSlave)

findGlobalOneByQuery

<T> T findGlobalOneByQuery(IQuery query,
                           String clusterName,
                           Class<T> clazz)

根据Query对象查询全局表数据. 查询不到则返回null

Parameters:

query - Query条件

clusterName - 集群名

clazz - 实体对象

Returns:

数据

findGlobalOneByQuery

<T> T findGlobalOneByQuery(IQuery query,
                           String clusterName,
                           Class<T> clazz,
                           boolean useCache)

findGlobalOneByQuery

<T> T findGlobalOneByQuery(IQuery query,
                           String clusterName,
                           Class<T> clazz,
                           EnumDBMasterSlave masterSlave)

根据Query对象查询全局表数据. 查询不到则返回null

Parameters:

query - Query条件

clusterName - 集群名

clazz - 实体对象

masterSlave - 指定主库或者从库

Returns:

数据

findGlobalOneByQuery

<T> T findGlobalOneByQuery(IQuery query,
                           String clusterName,
                           Class<T> clazz,
                           boolean useCache,
                           EnumDBMasterSlave masterSlave)

findGlobalByPks

<T> List<T> findGlobalByPks(String clusterName,
                            Class<T> clazz,
                            Number... pks)

根据主键查询全局表数据. 当查询不到数据时返回空的List，不会返回null.

Parameters:

clusterName - 集群名

clazz - 实体对象

pks - 主键

Returns:

数据

findGlobalByPks

<T> List<T> findGlobalByPks(String clusterName,
                            Class<T> clazz,
                            boolean useCache,
                            Number... pks)

findGlobalByPks

<T> List<T> findGlobalByPks(String clusterName,
                            Class<T> clazz,
                            EnumDBMasterSlave masterSlave,
                            Number... pks)

根据主键查询全局表数据. 当查询不到数据时返回空的List，不会返回null.

Parameters:

clusterName - 集群名

clazz - 实体对象

masterSlave - 指定主库或者从库

pks - 主键

Returns:

数据

findGlobalByPks

<T> List<T> findGlobalByPks(String clusterName,
                            Class<T> clazz,
                            EnumDBMasterSlave masterSlave,
                            boolean useCache,
                            Number... pks)

findGlobalByPkList

<T> List<T> findGlobalByPkList(List<? extends Number> pks,
                               String clusterName,
                               Class<T> clazz)

根据主键查询全局表数据. 当查询不到数据时返回空的List，不会返回null.

Parameters:

clusterName - 集群名

clazz - 实体对象

pks - 主键

Returns:

数据

findGlobalByPkList

<T> List<T> findGlobalByPkList(List<? extends Number> pks,
                               String clusterName,
                               Class<T> clazz,
                               boolean useCache)

findGlobalByPkList

<T> List<T> findGlobalByPkList(List<? extends Number> pks,
                               String clusterName,
                               Class<T> clazz,
                               EnumDBMasterSlave masterSlave)

根据主键查询全局表数据. 当查询不到数据时返回空的List，不会返回null.

Parameters:

clusterName - 集群名

clazz - 实体对象

pks - 主键

masterSlave - 指定主库或者从库

Returns:

数据

findGlobalByPkList

<T> List<T> findGlobalByPkList(List<? extends Number> pks,
                               String clusterName,
                               Class<T> clazz,
                               boolean useCache,
                               EnumDBMasterSlave masterSlave)

findGlobalBySql

List<Map<String,Object>> findGlobalBySql(SQL sql,
                                         String clusterName)

根据sql查询全局表. 当查询不到数据时返回空的List，不会返回null.

Parameters:

sql - 查询语句

clusterName - 集群名

Returns:

数据

findGlobalBySql

List<Map<String,Object>> findGlobalBySql(SQL sql,
                                         String clusterName,
                                         EnumDBMasterSlave masterSlave)

根据sql查询全局表. 当查询不到数据时返回空的List，不会返回null.

Parameters:

sql - 查询语句

clusterName - 集群名

masterSlave - 指定主库或者从库

Returns:

数据

findGlobalByQuery

<T> List<T> findGlobalByQuery(IQuery query,
                              String clusterName,
                              Class<T> clazz)

根据Query查询全局表. 当查询不到数据时返回空的List，不会返回null.

Parameters:

query - Query对象

clusterName - 集群名

clazz - 实体对象

Returns:

数据

findGlobalByQuery

<T> List<T> findGlobalByQuery(IQuery query,
                              String clusterName,
                              Class<T> clazz,
                              boolean useCache)

findGlobalByQuery

<T> List<T> findGlobalByQuery(IQuery query,
                              String clusterName,
                              Class<T> clazz,
                              EnumDBMasterSlave masterSlave)

根据Query查询全局表. 当查询不到数据时返回空的List，不会返回null.

Parameters:

query - Query对象

clusterName - 集群名

clazz - 实体对象

masterSlave - 指定主库或者从库

Returns:

数据

findGlobalByQuery

<T> List<T> findGlobalByQuery(IQuery query,
                              String clusterName,
                              Class<T> clazz,
                              boolean useCache,
                              EnumDBMasterSlave masterSlave)

getCount

Number getCount(Class<?> clazz)

获取分片实体的集群总数.

Parameters:

clazz -

Returns:

getCount

Number getCount(Class<?> clazz,
                boolean useCache)

getCount

Number getCount(Class<?> clazz,
                IQuery query)

根据查询条件获取记录.

Parameters:

clazz - 实体对象

query - 查询条件

Returns:

记录数

getCount

Number getCount(IShardingKey<?> shardingKey,
                Class<?> clazz)

获取分库分表记录总数.

Parameters:

shardingKey - 分库分表因子

clazz - 数据对象

Returns:

表记录总数

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

getCount

Number getCount(IShardingKey<?> shardingKey,
                Class<?> clazz,
                boolean useCache)

getCount

Number getCount(IQuery query,
                IShardingKey<?> shardingKey,
                Class<?> clazz)

根据查询条件获取某个分库分表的记录数.

Parameters:

query - 查询条件

shardingKey - 分片因子

clazz - 数据对象

Returns:

记录数

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findByPk

<T> T findByPk(Number pk,
               IShardingKey<?> shardingKey,
               Class<T> clazz)

一个主分库分表, 根据主键查询. 查询不到则返回null

Parameters:

pk - 主键

shardingKey - 分库分表因子

clazz - 数据对象类型

Returns:

查询结果，找不到返回null

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findByPk

<T> T findByPk(Number pk,
               IShardingKey<?> shardingKey,
               Class<T> clazz,
               boolean useCache)

findByPk

<T> T findByPk(Number pk,
               IShardingKey<?> shardingKey,
               Class<T> clazz,
               EnumDBMasterSlave masterSlave)

一个主分库分表, 根据主键查询. 查询不到则返回null

Parameters:

pk - 主键

shardingKey - 分库分表因子

clazz - 数据对象类型

masterSlave - 指定主库或者从库

Returns:

查询结果，找不到返回null

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findByPk

<T> T findByPk(Number pk,
               IShardingKey<?> shardingKey,
               Class<T> clazz,
               boolean useCache,
               EnumDBMasterSlave masterSlave)

findOneByQuery

<T> T findOneByQuery(IQuery query,
                     IShardingKey<?> shardingKey,
                     Class<T> clazz)

根据查询条件获取一条数据. 如果查询到多条则返回第一条.当查询不到数据时返回空的List，不会返回null.

Parameters:

query -

shardingKey -

clazz -

Returns:

查询结果，找不到返回null

findOneByQuery

<T> T findOneByQuery(IQuery query,
                     IShardingKey<?> shardingKey,
                     Class<T> clazz,
                     boolean useCache)

findOneByQuery

<T> T findOneByQuery(IQuery query,
                     IShardingKey<?> shardingKey,
                     Class<T> clazz,
                     EnumDBMasterSlave masterSlave)

根据查询条件获取一条数据. 如果查询到多条则返回第一条.当查询不到数据时返回空的List，不会返回null.

Parameters:

query -

shardingKey -

clazz -

masterSlave - 指定主库或者从库

Returns:

查询结果，找不到返回null

findOneByQuery

<T> T findOneByQuery(IQuery query,
                     IShardingKey<?> shardingKey,
                     Class<T> clazz,
                     boolean useCache,
                     EnumDBMasterSlave masterSlave)

findByPks

<T> List<T> findByPks(IShardingKey<?> shardingKey,
                      Class<T> clazz,
                      Number... pks)

一个主分库分表, 根据多个主键查询.当查询不到数据时返回空的List，不会返回null.

Parameters:

shardingKey - 分库分表因子

clazz - 数据对象类型

pks - 主键

Returns:

查询结果

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findByPks

<T> List<T> findByPks(IShardingKey<?> shardingKey,
                      Class<T> clazz,
                      boolean useCache,
                      Number... pks)

findByPks

<T> List<T> findByPks(IShardingKey<?> shardingKey,
                      Class<T> clazz,
                      EnumDBMasterSlave masterSlave,
                      Number... pks)

一个主分库分表, 根据多个主键查询.当查询不到数据时返回空的List，不会返回null.

Parameters:

shardingKey - 分库分表因子

clazz - 数据对象类型

masterSlave - 指定主库或者从库

pks - 主键

Returns:

查询结果

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findByPks

<T> List<T> findByPks(IShardingKey<?> shardingKey,
                      Class<T> clazz,
                      EnumDBMasterSlave masterSlave,
                      boolean useCache,
                      Number... pks)

findByPkList

<T> List<T> findByPkList(List<? extends Number> pks,
                         IShardingKey<?> shardingKey,
                         Class<T> clazz)

一个主分库分表, 根据多个主键查询.当查询不到数据时返回空的List，不会返回null.

Parameters:

pks - 主键数组

shardingKey - 分库分表因子

clazz - 数据对象类型

Returns:

查询结果

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findByPkList

<T> List<T> findByPkList(List<? extends Number> pks,
                         IShardingKey<?> shardingKey,
                         Class<T> clazz,
                         boolean useCache)

findByPkList

<T> List<T> findByPkList(List<? extends Number> pks,
                         IShardingKey<?> shardingKey,
                         Class<T> clazz,
                         EnumDBMasterSlave masterSlave)

一个主分库分表, 根据多个主键查询.当查询不到数据时返回空的List，不会返回null.

Parameters:

pks - 主键数组

shardingKey - 分库分表因子

clazz - 数据对象类型

masterSlave - 指定主库或者从库

Returns:

查询结果

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findByPkList

<T> List<T> findByPkList(List<? extends Number> pks,
                         IShardingKey<?> shardingKey,
                         Class<T> clazz,
                         boolean useCache,
                         EnumDBMasterSlave masterSlave)

findBySql

List<Map<String,Object>> findBySql(SQL sql,
                                   IShardingKey<?> shardingKey)

一个主分库分表, 根据条件查询.当查询不到数据时返回空的List，不会返回null. 需要注意的是，sql语句中操作的表必须在指定的分片中存在.

Parameters:

sql - 查询语句

shardingKey - 分库分表因子

Returns:

查询结果

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findBySql

List<Map<String,Object>> findBySql(SQL sql,
                                   IShardingKey<?> shardingKey,
                                   EnumDBMasterSlave masterSlave)

一个主分库分表, 根据条件查询.当查询不到数据时返回空的List，不会返回null. 需要注意的是，sql语句中操作的表必须在指定的分片中存在.

Parameters:

sql - 查询语句

shardingKey - 分库分表因子

masterSlave - 指定主库或者从库

Returns:

查询结果

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findByQuery

<T> List<T> findByQuery(IQuery query,
                        IShardingKey<?> shardingKey,
                        Class<T> clazz)

根据查询条件对象进行查询.当查询不到数据时返回空的List，不会返回null.

Parameters:

query - 查询条件

shardingKey - 分库分表因子

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findByQuery

<T> List<T> findByQuery(IQuery query,
                        IShardingKey<?> shardingKey,
                        Class<T> clazz,
                        boolean useCache)

findByQuery

<T> List<T> findByQuery(IQuery query,
                        IShardingKey<?> shardingKey,
                        Class<T> clazz,
                        EnumDBMasterSlave masterSlave)

根据查询条件对象进行查询.当查询不到数据时返回空的List，不会返回null.

Parameters:

query - 查询条件

shardingKey - 分库分表因子

masterSlave - 指定主库或者从库

Throws:

DBOperationException - 操作失败

IllegalArgumentException - 输入参数错误

findByQuery

<T> List<T> findByQuery(IQuery query,
                        IShardingKey<?> shardingKey,
                        Class<T> clazz,
                        boolean useCache,
                        EnumDBMasterSlave masterSlave)

createLock

Lock createLock(String lockName)

创建一个分布式锁.

Parameters:

lockName - 锁名称

Returns:

setIdGenerator

void setIdGenerator(IIdGenerator idGenerator)

设置ID生成器.

Parameters:

idGenerator -

getIdGenerator

IIdGenerator getIdGenerator()

获取ID生成器

Returns:

ID生成器

getDbCluster

IDBCluster getDbCluster()

获取当前使用的数据库集群.

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 - 批量数

createQuery

IQuery createQuery()

创建一个查询条件对象.

Returns:

查询条件对象

setEnumDb

void setEnumDb(EnumDB enumDb)

设置存储使用的数据库. 默认使用mysql

Parameters:

enumDb - 数据库枚举

init

void init()
   throws LoadConfigException

初始化集群客户端.

Throws:

LoadConfigException

destroy

void destroy()

关闭存储.

setSyncAction

void setSyncAction(EnumSyncAction syncAction)

设置数据表同步动作.

Parameters:

syncAction -

setScanPackage

void setScanPackage(String scanPackage)

设置扫描的实体对象包. 用户加载分表信息和自动创建数据表.

Parameters:

scanPackage -