com.dangdang.ddframe.rdb.sharding.api.rule

类 ShardingRule

java.lang.Object

com.dangdang.ddframe.rdb.sharding.api.rule.ShardingRule

public final class ShardingRule
extends Object

分库分表规则配置对象.

作者:

zhangliang

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ShardingRule.ShardingRuleBuilder 分片规则配置对象构建器.

构造器概要

构造器

构造器和说明
ShardingRule(DataSourceRule dataSourceRule, Collection<TableRule> tableRules, Collection<BindingTableRule> bindingTableRules, DatabaseShardingStrategy databaseShardingStrategy, TableShardingStrategy tableShardingStrategy, KeyGenerator keyGenerator) 已过时。 未来将改为private权限, 不在对外公开, 不建议使用非Spring命名空间的配置.

方法概要

方法

限定符和类型	方法和说明
static ShardingRule.ShardingRuleBuilder	builder() 获取表规则配置对象构建器.
Collection<String>	filterAllBindingTables(Collection<String> logicTables) 过滤出所有的Binding表名称.
com.google.common.base.Optional<BindingTableRule>	findBindingTableRule(String logicTable) 根据逻辑表名称获取binding表配置的逻辑表名称集合.
Number	generateKey(String tableName) 获取自增主键.
DatabaseShardingStrategy	getDatabaseShardingStrategy(TableRule tableRule) 获取数据库分片策略.
com.google.common.base.Optional<String>	getGenerateKeyColumn(String tableName) 获取自增列名称.
TableRule	getTableRule(String logicTableName) 根据逻辑表名称查找分片规则.
TableShardingStrategy	getTableShardingStrategy(TableRule tableRule) 获取表分片策略.
boolean	isAllBindingTables(Collection<String> logicTables) 判断逻辑表名称集合是否全部属于Binding表.
boolean	isShardingColumn(Column column) 判断是否为分片列.
com.google.common.base.Optional<TableRule>	tryFindTableRule(String logicTableName) 试着根据逻辑表名称查找分片规则.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ShardingRule

@Deprecated
public ShardingRule(DataSourceRule dataSourceRule,
                       Collection<TableRule> tableRules,
                       Collection<BindingTableRule> bindingTableRules,
                       DatabaseShardingStrategy databaseShardingStrategy,
                       TableShardingStrategy tableShardingStrategy,
                       KeyGenerator keyGenerator)

已过时。 未来将改为private权限, 不在对外公开, 不建议使用非Spring命名空间的配置.

全属性构造器.

用于Spring非命名空间的配置.

未来将改为private权限, 不在对外公开, 不建议使用非Spring命名空间的配置.

参数:

dataSourceRule - 数据源配置规则

tableRules - 表配置规则

bindingTableRules - 绑定表配置规则

databaseShardingStrategy - 默认分库策略

tableShardingStrategy - 默认分表策略

keyGenerator - 默认主键生成器

方法详细资料

builder

public static ShardingRule.ShardingRuleBuilder builder()

获取表规则配置对象构建器.

返回:

分片规则配置对象构建器

tryFindTableRule

public com.google.common.base.Optional<TableRule> tryFindTableRule(String logicTableName)

试着根据逻辑表名称查找分片规则.

参数:

logicTableName - 逻辑表名称

返回:

该逻辑表的分片规则

getTableRule

public TableRule getTableRule(String logicTableName)

根据逻辑表名称查找分片规则.

参数:

logicTableName - 逻辑表名称

返回:

该逻辑表的分片规则

getDatabaseShardingStrategy

public DatabaseShardingStrategy getDatabaseShardingStrategy(TableRule tableRule)

获取数据库分片策略.

根据表规则配置对象获取分片策略, 如果获取不到则获取默认分片策略.

参数:

tableRule - 表规则配置对象

返回:

数据库分片策略

getTableShardingStrategy

public TableShardingStrategy getTableShardingStrategy(TableRule tableRule)

获取表分片策略.

根据表规则配置对象获取分片策略, 如果获取不到则获取默认分片策略.

参数:

tableRule - 表规则配置对象

返回:

表分片策略

isAllBindingTables

public boolean isAllBindingTables(Collection<String> logicTables)

判断逻辑表名称集合是否全部属于Binding表.

参数:

logicTables - 逻辑表名称集合

返回:

是否全部属于Binding表

filterAllBindingTables

public Collection<String> filterAllBindingTables(Collection<String> logicTables)

过滤出所有的Binding表名称.

参数:

logicTables - 逻辑表名称集合

返回:

所有的Binding表名称集合

findBindingTableRule

public com.google.common.base.Optional<BindingTableRule> findBindingTableRule(String logicTable)

根据逻辑表名称获取binding表配置的逻辑表名称集合.

参数:

logicTable - 逻辑表名称

返回:

binding表配置的逻辑表名称集合

isShardingColumn

public boolean isShardingColumn(Column column)

判断是否为分片列.

参数:

column - 列对象

返回:

是否为分片列

getGenerateKeyColumn

public com.google.common.base.Optional<String> getGenerateKeyColumn(String tableName)

获取自增列名称.

参数:

tableName - 表名称

返回:

自增列名称

generateKey

public Number generateKey(String tableName)

获取自增主键.

参数:

tableName - 表名称

返回:

生成的自增主键