ShardingRule (sharding-core-common 4.1.1 API)

java.lang.Object
- org.apache.shardingsphere.core.rule.ShardingRule

所有已实现的接口:

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

构造器概要

构造器
构造器和说明

ShardingRule(ShardingRuleConfiguration shardingRuleConfig, Collection<String> dataSourceNames)

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Optional<String>`	`findActualDefaultDataSourceName()` Find actual default data source name.
`Optional<BindingTableRule>`	`findBindingTableRule(String logicTableName)` Find binding table rule via logic table name.
`Optional<String>`	`findGenerateKeyColumnName(String logicTableName)` Find column name of generated key.
`Optional<MasterSlaveRule>`	`findMasterSlaveRule(String dataSourceName)` Find master slave rule.
`Optional<TableRule>`	`findTableRule(String logicTableName)` Find table rule.
`Optional<TableRule>`	`findTableRuleByActualTable(String actualTableName)` Find table rule via actual table name.
`Comparable<?>`	`generateKey(String logicTableName)` Generate key.
`ShardingStrategy`	`getDatabaseShardingStrategy(TableRule tableRule)` Get database sharding strategy.
`DataNode`	`getDataNode(String logicTableName)` Find data node by logic table name.
`DataNode`	`getDataNode(String dataSourceName, String logicTableName)` Find data node by data source and logic table.
`Map<String,String>`	`getLogicAndActualTablesFromBindingTable(String dataSourceName, String logicTable, String actualTable, Collection<String> availableLogicBindingTables)` Get logic and actual binding tables.
`Collection<String>`	`getLogicTableNames(String actualTableName)` Get logic table names based on actual table name.
`Collection<String>`	`getShardingLogicTableNames(Collection<String> logicTableNames)` Get sharding logic table names.
`TableRule`	`getTableRule(String logicTableName)` Get table rule.
`ShardingStrategy`	`getTableShardingStrategy(TableRule tableRule)` Get table sharding strategy.
`boolean`	`hasDefaultDataSourceName()` Judge if default data source mame exists.
`boolean`	`isAllBindingTables(Collection<String> logicTableNames)` Judge logic tables is all belong to binding encryptors.
`boolean`	`isAllBroadcastTables(Collection<String> logicTableNames)` Judge logic tables is all belong to broadcast encryptors.
`boolean`	`isAllInDefaultDataSource(Collection<String> logicTableNames)` Judge logic tables is all belong to default data source.
`boolean`	`isBroadcastTable(String logicTableName)` Judge logic table is belong to broadcast tables.
`boolean`	`isShardingColumn(String columnName, String tableName)` Judge is sharding column or not.
`boolean`	`tableRuleExists(Collection<String> logicTableNames)` Judge if there is at least one table rule for logic tables.
`Collection<BaseRule>`	`toRules()` To rules.

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

从接口继承的方法 org.apache.shardingsphere.underlying.common.rule.BaseRule
getRuleConfiguration

- 构造器详细资料
  - ShardingRule
```
public ShardingRule(ShardingRuleConfiguration shardingRuleConfig,
                    Collection<String> dataSourceNames)
```
- 方法详细资料
  - findTableRule
```
public Optional<TableRule> findTableRule(String logicTableName)
```
    Find table rule.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    table rule
  - findTableRuleByActualTable
```
public Optional<TableRule> findTableRuleByActualTable(String actualTableName)
```
    Find table rule via actual table name.
    
    参数:
    
    actualTableName - actual table name
    
    返回:
    
    table rule
  - getTableRule
```
public TableRule getTableRule(String logicTableName)
```
    Get table rule.
    
    参数:
    
    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
  - isAllBindingTables
```
public boolean isAllBindingTables(Collection<String> logicTableNames)
```
    Judge logic tables is all belong to binding encryptors.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    logic tables is all belong to binding encryptors or not
  - findBindingTableRule
```
public Optional<BindingTableRule> findBindingTableRule(String logicTableName)
```
    Find binding table rule via logic table name.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    binding table rule
  - isAllBroadcastTables
```
public boolean isAllBroadcastTables(Collection<String> logicTableNames)
```
    Judge logic tables is all belong to broadcast encryptors.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    logic tables is all belong to broadcast encryptors or not
  - isBroadcastTable
```
public boolean isBroadcastTable(String logicTableName)
```
    Judge logic table is belong to broadcast tables.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    logic table is belong to broadcast tables or not
  - isAllInDefaultDataSource
```
public boolean isAllInDefaultDataSource(Collection<String> logicTableNames)
```
    Judge logic tables is all belong to default data source.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    logic tables is all belong to default data source
  - tableRuleExists
```
public boolean tableRuleExists(Collection<String> logicTableNames)
```
    Judge if there is at least one table rule for logic tables.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    whether a table rule exists for logic tables
  - isShardingColumn
```
public boolean isShardingColumn(String columnName,
                                String tableName)
```
    Judge is sharding column or not.
    
    参数:
    
    columnName - column name
    
    tableName - table name
    
    返回:
    
    is sharding column or not
  - findGenerateKeyColumnName
```
public Optional<String> findGenerateKeyColumnName(String logicTableName)
```
    Find column name of generated key.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    column name of generated key
  - generateKey
```
public Comparable<?> generateKey(String logicTableName)
```
    Generate key.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    generated key
  - getLogicTableNames
```
public Collection<String> getLogicTableNames(String actualTableName)
```
    Get logic table names based on actual table name.
    
    参数:
    
    actualTableName - actual table name
    
    返回:
    
    logic table name
  - getDataNode
```
public DataNode getDataNode(String logicTableName)
```
    Find data node by logic table name.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    data node
  - getDataNode
```
public DataNode getDataNode(String dataSourceName,
                            String logicTableName)
```
    Find data node by data source and logic table.
    
    参数:
    
    dataSourceName - data source name
    
    logicTableName - logic table name
    
    返回:
    
    data node
  - hasDefaultDataSourceName
```
public boolean hasDefaultDataSourceName()
```
    Judge if default data source mame exists.
    
    返回:
    
    if default data source name exists
  - findActualDefaultDataSourceName
```
public 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 Optional<MasterSlaveRule> findMasterSlaveRule(String dataSourceName)
```
    Find master slave rule.
    
    参数:
    
    dataSourceName - data source name
    
    返回:
    
    master slave rule
  - getShardingLogicTableNames
```
public Collection<String> getShardingLogicTableNames(Collection<String> logicTableNames)
```
    Get sharding logic table names.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    sharding logic table names
  - getLogicAndActualTablesFromBindingTable
```
public Map<String,String> getLogicAndActualTablesFromBindingTable(String dataSourceName,
                                                                  String logicTable,
                                                                  String actualTable,
                                                                  Collection<String> availableLogicBindingTables)
```
    Get logic and actual binding tables.
    
    参数:
    
    dataSourceName - data source name
    
    logicTable - logic table name
    
    actualTable - actual table name
    
    availableLogicBindingTables - available logic binding table names
    
    返回:
    
    logic and actual binding tables
  - toRules
```
public Collection<BaseRule> toRules()
```
    To rules.
    
    返回:
    
    rules

类 ShardingRule

构造器概要

方法概要

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

从接口继承的方法 org.apache.shardingsphere.underlying.common.rule.BaseRule

构造器详细资料

ShardingRule

方法详细资料

findTableRule

findTableRuleByActualTable

getTableRule

getDatabaseShardingStrategy

getTableShardingStrategy

isAllBindingTables

findBindingTableRule

isAllBroadcastTables

isBroadcastTable

isAllInDefaultDataSource

tableRuleExists

isShardingColumn

findGenerateKeyColumnName

generateKey

getLogicTableNames

getDataNode

getDataNode

hasDefaultDataSourceName

findActualDefaultDataSourceName

findMasterSlaveRule

getShardingLogicTableNames

getLogicAndActualTablesFromBindingTable

toRules