org.pinus4j.cluster

Interface IDBCluster

All Known Implementing Classes:

AbstractDBCluster, AppDBClusterImpl, EnvDBClusterImpl

public interface IDBCluster

数据库集群. 数据库集群主要类，持有所有的数据库集群信息，保存集群的数据库连接包括主库和从库。 初始化集群的方法，
当没有设置scanpakcage时，从zookeeper中加载. 已DbcpDBClusterImpl实现为例

 IDBCluster dbCluster = new DbcpDBClusterImpl(); 

 dbCluster.setDbRouteAlg(EnumDBRouteAlg); // 设置分片路由算法. 可选
 dbCluster.setScanPackage("entity full path package"); // 可选
 dbCluster.setShardInfoFromZk(true | false); // 默认为false, 可选
 dbCluster.startup();
 

Author:

duanbn

Method Summary

Modifier and Type	Method and Description
Lock	createLock(String name) create a destribute lock by give name.
List<DB>	getAllMasterShardingDB(Class<?> clazz) 获取此实体对象对应的所有的分库分表引用.
List<DB>	getAllMasterShardingDB(int tableNum, String clusterName, String tableName) get all master sharding info.
List<DB>	getAllSlaveShardingDB(Class<?> clazz, EnumDBMasterSlave slave) 获取集群从库列表.
IClusterConfig	getClusterConfig() 获取集群配置.
IDataLayerBuilder	getDataLayerBuilder() get data layer component builder.
Collection<DBClusterInfo>	getDBClusterInfo() Get all info about this cluster.
DBClusterInfo	getDBClusterInfo(String clusterName) 获取集群信息.
IDBGenerator	getDBGenerator() 获取db生成器.
IClusterRouter	getDBRouter(String clusterName) get cluster router.
List<DBTable>	getDBTableFromJvm() 从Jvm中获取分片信息.
List<DBTable>	getDBTableFromZk() 从Zookeeper中获取分片信息.
IIdGenerator	getIdGenerator() 获取id生成器.
DBInfo	getMasterGlobalConn(String clusterName) 获取主全局库连接.
DBInfo	getSlaveGlobalDbConn(String clusterName, EnumDBMasterSlave slave) 获取从库的全局库连接
ITableCluster	getTableCluster() 获取集群表集合.
DB	selectDbFromMaster(String tableName, IShardingKey<?> value) 从主库集群中获取被操作的库表.
DB	selectDbFromSlave(String tableName, IShardingKey<?> value, EnumDBMasterSlave slave) 从从库集群中获取被操作的库表.
void	setScanPackage(String scanPackage) 设置需要扫描的实体对象包.
void	setShardInfoFromZk(boolean value) 设置此集群是否从zookeeper中加载分片信息.
void	setSyncAction(EnumSyncAction syncAction) 设置数据表同步动作.
void	shutdown() 关闭集群.
void	startup() 启动集群.
void	startup(String xmlFilePath) 启动集群.

Method Detail

createLock

Lock createLock(String name)

create a destribute lock by give name.

Returns:

destirbute lock.

getDataLayerBuilder

IDataLayerBuilder getDataLayerBuilder()

get data layer component builder.

See Also:

IDataLayerBuilder

setShardInfoFromZk

void setShardInfoFromZk(boolean value)

设置此集群是否从zookeeper中加载分片信息.

Parameters:

value - true:是， false:否.

getDBTableFromZk

List<DBTable> getDBTableFromZk()

从Zookeeper中获取分片信息.

Returns:

分片信息.

getDBTableFromJvm

List<DBTable> getDBTableFromJvm()

从Jvm中获取分片信息.

Returns:

分片信息.

getDBClusterInfo

Collection<DBClusterInfo> getDBClusterInfo()

Get all info about this cluster.

Returns:

all cluster info.

getDBClusterInfo

DBClusterInfo getDBClusterInfo(String clusterName)

获取集群信息.

Parameters:

clusterName - 集群名

Returns:

集群信息

startup

void startup()
      throws DBClusterException

启动集群. 调用数据库集群前需要调用此方法，为了初始化集群连接.

Throws:

DBClusterException - 初始化失败

startup

void startup(String xmlFilePath)
      throws DBClusterException

启动集群. 调用数据库集群前需要调用此方法，为了初始化集群连接.

Parameters:

xmlFilePath - 配置文件绝对路径

Throws:

DBClusterException - 初始化失败

shutdown

void shutdown()
       throws DBClusterException

关闭集群. 系统停止时关闭数据库集群.

Throws:

DBClusterException - 关闭失败

getMasterGlobalConn

DBInfo getMasterGlobalConn(String clusterName)
                    throws DBClusterException

获取主全局库连接.

Parameters:

clusterName -

Returns:

Throws:

DBClusterException

getSlaveGlobalDbConn

DBInfo getSlaveGlobalDbConn(String clusterName,
                            EnumDBMasterSlave slave)
                     throws DBClusterException

获取从库的全局库连接

Parameters:

clusterName -

slave -

Returns:

Throws:

DBClusterException

selectDbFromMaster

DB selectDbFromMaster(String tableName,
                      IShardingKey<?> value)
               throws DBClusterException

从主库集群中获取被操作的库表.

Parameters:

tableName - 数据表名

value - 分库分表因子.

Returns:

被操作的库表

Throws:

DBClusterException

selectDbFromSlave

DB selectDbFromSlave(String tableName,
                     IShardingKey<?> value,
                     EnumDBMasterSlave slave)
              throws DBClusterException

从从库集群中获取被操作的库表.

Parameters:

slave - 从库

tableName - 数据库表名

value - 分库分表因子

Returns:

被操作的库表

Throws:

DBClusterException

getAllMasterShardingDB

List<DB> getAllMasterShardingDB(Class<?> clazz)

获取此实体对象对应的所有的分库分表引用.

Parameters:

clazz - 数据对象

Returns:

getAllMasterShardingDB

List<DB> getAllMasterShardingDB(int tableNum,
                                String clusterName,
                                String tableName)

get all master sharding info.

Parameters:

tableNum -

clusterName -

tableName -

Returns:

getAllSlaveShardingDB

List<DB> getAllSlaveShardingDB(Class<?> clazz,
                               EnumDBMasterSlave slave)

获取集群从库列表.

Parameters:

clazz - 数据对象

slave - 从库号

getDBRouter

IClusterRouter getDBRouter(String clusterName)

get cluster router.

setSyncAction

void setSyncAction(EnumSyncAction syncAction)

设置数据表同步动作.

Parameters:

syncAction -

getDBGenerator

IDBGenerator getDBGenerator()

获取db生成器.

getIdGenerator

IIdGenerator getIdGenerator()

获取id生成器.

Returns:

setScanPackage

void setScanPackage(String scanPackage)

设置需要扫描的实体对象包.

Parameters:

scanPackage - 包名

getTableCluster

ITableCluster getTableCluster()

获取集群表集合.

Returns:

集群表集合

getClusterConfig

IClusterConfig getClusterConfig()

获取集群配置.

Returns: