ShardingRule (sharding-core 3.1.0 API)

java.lang.Object
- io.shardingsphere.core.rule.ShardingRule

```
public class ShardingRule
extends Object
```
Databases and tables sharding rule configuration.

作者:

zhangliang, maxiaoguang, panjuan

构造器概要

构造器
构造器和说明

ShardingRule(ShardingRuleConfiguration shardingRuleConfig, Collection<String> dataSourceNames)

构造器
构造器和说明
`ShardingRule(ShardingRuleConfiguration shardingRuleConfig, Collection<String> dataSourceNames)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`contains(String tableName)` Adjust contains table in sharding rule.
`com.google.common.base.Optional<String>`	`findActualDefaultDataSourceName()` Find actual default data source name.
`com.google.common.base.Optional<BindingTableRule>`	`findBindingTableRule(String logicTable)` Get binding table rule via logic table name.
`DataNode`	`findDataNode(String logicTableName)` Find data node by logic table.
`DataNode`	`findDataNode(String dataSourceName, String logicTableName)` Find data node by data source and logic table.
`com.google.common.base.Optional<MasterSlaveRule>`	`findMasterSlaveRule(String dataSourceName)` Find master slave rule.
`com.google.common.base.Optional<TableRule>`	`findTableRuleByActualTable(String actualTableName)` Find table rule though actual table name.
`com.google.common.base.Optional<TableRule>`	`findTableRuleByLogicTable(String logicTableName)` Find table rule though logic table name.
`Number`	`generateKey(String logicTableName)` Generate key.
`String`	`getActualDataSourceNameByActualTableName(String actualTableName)` Get actual data source name by actual table name.
`ShardingStrategy`	`getDatabaseShardingStrategy(TableRule tableRule)` Get database sharding strategy.
`com.google.common.base.Optional<Column>`	`getGenerateKeyColumn(String logicTableName)` get generated key's column.
`String`	`getLogicTableName(String logicIndexName)` Get logic table name base on logic index name.
`TableRule`	`getTableRuleByLogicTableName(String logicTableName)` Find table rule though logic table name.
`ShardingStrategy`	`getTableShardingStrategy(TableRule tableRule)` Get table sharding strategy.
`boolean`	`isAllBindingTables(Collection<String> logicTables)` Adjust logic tables is all belong to binding tables.
`boolean`	`isAllBroadcastTables(Collection<String> logicTables)` Adjust logic tables is all belong to broadcast tables.
`boolean`	`isAllInDefaultDataSource(Collection<String> logicTables)` Adjust logic tables is all belong to default data source.
`boolean`	`isBroadcastTable(String logicTable)` Adjust logic table is belong to broadcast tables.
`boolean`	`isLogicIndex(String logicIndexName, String logicTableName)` Adjust is logic index or not.
`boolean`	`isShardingColumn(Column column)` Adjust is sharding column or not.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ShardingRule
```
public ShardingRule(ShardingRuleConfiguration shardingRuleConfig,
                    Collection<String> dataSourceNames)
```
- 方法详细资料
  - findTableRuleByLogicTable
```
public com.google.common.base.Optional<TableRule> findTableRuleByLogicTable(String logicTableName)
```
    Find table rule though logic table name.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    table rule
  - findTableRuleByActualTable
```
public com.google.common.base.Optional<TableRule> findTableRuleByActualTable(String actualTableName)
```
    Find table rule though actual table name.
    
    参数:
    
    actualTableName - actual table name
    
    返回:
    
    table rule
  - getTableRuleByLogicTableName
```
public TableRule getTableRuleByLogicTableName(String logicTableName)
```
    Find table rule though logic table name.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    table rule
  - getDatabaseShardingStrategy
```
public ShardingStrategy getDatabaseShardingStrategy(TableRule tableRule)
```
    Get database sharding strategy.
    Use default database sharding strategy if not found.
    
    参数:
    
    tableRule - table rule
    
    返回:
    
    database sharding strategy
  - getTableShardingStrategy
```
public ShardingStrategy getTableShardingStrategy(TableRule tableRule)
```
    Get table sharding strategy.
    Use default table sharding strategy if not found.
    
    参数:
    
    tableRule - table rule
    
    返回:
    
    table sharding strategy
  - isBroadcastTable
```
public boolean isBroadcastTable(String logicTable)
```
    Adjust logic table is belong to broadcast tables.
    
    参数:
    
    logicTable - logic table name
    
    返回:
    
    logic table is belong to broadcast tables or not
  - isAllBroadcastTables
```
public boolean isAllBroadcastTables(Collection<String> logicTables)
```
    Adjust logic tables is all belong to broadcast tables.
    
    参数:
    
    logicTables - names of logic tables
    
    返回:
    
    logic tables is all belong to broadcast tables or not
  - isAllBindingTables
```
public boolean isAllBindingTables(Collection<String> logicTables)
```
    Adjust logic tables is all belong to binding tables.
    
    参数:
    
    logicTables - names of logic tables
    
    返回:
    
    logic tables is all belong to binding tables or not
  - isAllInDefaultDataSource
```
public boolean isAllInDefaultDataSource(Collection<String> logicTables)
```
    Adjust logic tables is all belong to default data source.
    
    参数:
    
    logicTables - names of logic tables
    
    返回:
    
    logic tables is all belong to default data source
  - findBindingTableRule
```
public com.google.common.base.Optional<BindingTableRule> findBindingTableRule(String logicTable)
```
    Get binding table rule via logic table name.
    
    参数:
    
    logicTable - logic table name
    
    返回:
    
    binding table rule
  - isShardingColumn
```
public boolean isShardingColumn(Column column)
```
    Adjust is sharding column or not.
    
    参数:
    
    column - column object
    
    返回:
    
    is sharding column or not
  - getGenerateKeyColumn
```
public com.google.common.base.Optional<Column> getGenerateKeyColumn(String logicTableName)
```
    get generated key's column.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    generated key's column
  - generateKey
```
public Number generateKey(String logicTableName)
```
    Generate key.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    generated key
  - getLogicTableName
```
public String getLogicTableName(String logicIndexName)
```
    Get logic table name base on logic index name.
    
    参数:
    
    logicIndexName - logic index name
    
    返回:
    
    logic table name
  - findDataNode
```
public DataNode findDataNode(String logicTableName)
```
    Find data node by logic table.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    data node
  - findDataNode
```
public DataNode findDataNode(String dataSourceName,
                             String logicTableName)
```
    Find data node by data source and logic table.
    
    参数:
    
    dataSourceName - data source name
    
    logicTableName - logic table name
    
    返回:
    
    data node
  - isLogicIndex
```
public boolean isLogicIndex(String logicIndexName,
                            String logicTableName)
```
    Adjust is logic index or not.
    
    参数:
    
    logicIndexName - logic index name
    
    logicTableName - logic table name
    
    返回:
    
    is logic index or not
  - findActualDefaultDataSourceName
```
public com.google.common.base.Optional<String> findActualDefaultDataSourceName()
```
    Find actual default data source name.
    If use master-slave rule, return master data source name.
    
    返回:
    
    actual default data source name
  - findMasterSlaveRule
```
public com.google.common.base.Optional<MasterSlaveRule> findMasterSlaveRule(String dataSourceName)
```
    Find master slave rule.
    
    参数:
    
    dataSourceName - data source name
    
    返回:
    
    master slave rule
  - getActualDataSourceNameByActualTableName
```
public String getActualDataSourceNameByActualTableName(String actualTableName)
```
    Get actual data source name by actual table name.
    
    参数:
    
    actualTableName - actual table name
    
    返回:
    
    actual data source name
  - contains
```
public boolean contains(String tableName)
```
    Adjust contains table in sharding rule.
    
    参数:
    
    tableName - table name
    
    返回:
    
    contains table in sharding rule or not

类 ShardingRule

构造器概要

方法概要

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

构造器详细资料

ShardingRule

方法详细资料

findTableRuleByLogicTable

findTableRuleByActualTable

getTableRuleByLogicTableName

getDatabaseShardingStrategy

getTableShardingStrategy

isBroadcastTable

isAllBroadcastTables

isAllBindingTables

isAllInDefaultDataSource

findBindingTableRule

isShardingColumn

getGenerateKeyColumn

generateKey

getLogicTableName

findDataNode

findDataNode

isLogicIndex

findActualDefaultDataSourceName

findMasterSlaveRule

getActualDataSourceNameByActualTableName

contains