ShardingRule (shardingsphere-sharding-core 5.2.1 API)

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

所有已实现的接口:

org.apache.shardingsphere.infra.rule.identifier.scope.DatabaseRule, org.apache.shardingsphere.infra.rule.identifier.type.DataNodeContainedRule, org.apache.shardingsphere.infra.rule.identifier.type.TableContainedRule, org.apache.shardingsphere.infra.rule.ShardingSphereRule
```
public final class ShardingRule
extends Object
implements org.apache.shardingsphere.infra.rule.identifier.scope.DatabaseRule, org.apache.shardingsphere.infra.rule.identifier.type.DataNodeContainedRule, org.apache.shardingsphere.infra.rule.identifier.type.TableContainedRule
```
Sharding rule.

构造器概要

构造器
构造器和说明
`ShardingRule(AlgorithmProvidedShardingRuleConfiguration config, Collection<String> dataSourceNames, org.apache.shardingsphere.infra.instance.InstanceContext instanceContext)`
`ShardingRule(ShardingRuleConfiguration config, Collection<String> dataSourceNames, org.apache.shardingsphere.infra.instance.InstanceContext instanceContext)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Optional<String>`	`findActualTableByCatalog(String catalog, String logicTable)`
`Optional<BindingTableRule>`	`findBindingTableRule(String logicTableName)` Find binding table rule via logic table name.
`Optional<String>`	`findFirstActualTable(String logicTable)`
`Optional<String>`	`findGenerateKeyColumnName(String logicTableName)` Find column name of generated key.
`Optional<String>`	`findLogicTableByActualTable(String actualTable)`
`Optional<String>`	`findShardingColumn(String columnName, String tableName)` Find sharding column.
`Optional<TableRule>`	`findTableRule(String logicTableName)` Find table rule.
`Optional<TableRule>`	`findTableRuleByActualTable(String actualTableName)` Find table rule via actual table name.
`Comparable<?>`	`generateKey(String logicTableName)` Find the Generated key of logic table.
`Map<String,Collection<org.apache.shardingsphere.infra.datanode.DataNode>>`	`getAllDataNodes()`
`Collection<String>`	`getAllTables()`
`ShardingAuditStrategyConfiguration`	`getAuditStrategyConfiguration(TableRule tableRule)` Get audit strategy configuration.
`ShardingStrategyConfiguration`	`getDatabaseShardingStrategyConfiguration(TableRule tableRule)` Get database sharding strategy configuration.
`org.apache.shardingsphere.infra.datanode.DataNode`	`getDataNode(String logicTableName)` Find data node by logic table name.
`Collection<org.apache.shardingsphere.infra.datanode.DataNode>`	`getDataNodesByTableName(String tableName)`
`Map<String,String>`	`getLogicAndActualTablesFromBindingTable(String dataSourceName, String logicTable, String actualTable, Collection<String> availableLogicBindingTables)` Get logic and actual binding tables.
`Collection<String>`	`getLogicTablesByActualTable(String actualTable)` Get logic tables via actual table name.
`Collection<String>`	`getShardingLogicTableNames(Collection<String> logicTableNames)` Get sharding logic table names.
`Collection<String>`	`getShardingRuleTableNames(Collection<String> logicTableNames)` Get sharding rule table names.
`TableRule`	`getTableRule(String logicTableName)` Get table rule.
`Collection<String>`	`getTables()`
`ShardingStrategyConfiguration`	`getTableShardingStrategyConfiguration(TableRule tableRule)` Get table sharding strategy configuration.
`String`	`getType()`
`boolean`	`isAllBindingTables(Collection<String> logicTableNames)` Judge whether logic table is all binding tables or not.
`boolean`	`isAllBindingTables(org.apache.shardingsphere.infra.metadata.database.ShardingSphereDatabase database, SQLStatementContext<?> sqlStatementContext, Collection<String> logicTableNames)` Judge whether logic table is all binding tables.
`boolean`	`isAllBroadcastTables(Collection<String> logicTableNames)` Judge whether logic table is all broadcast tables or not.
`boolean`	`isAllShardingTables(Collection<String> logicTableNames)` Judge whether logic table is all sharding table or not.
`boolean`	`isAllTablesInSameDataSource(Collection<String> logicTableNames)` Judge whether all tables are in same data source or not.
`boolean`	`isBroadcastTable(String logicTableName)` Judge whether logic table is broadcast table or not.
`boolean`	`isGenerateKeyColumn(String columnName, String tableName)` Judge whether given logic table column is generate key column or not.
`boolean`	`isNeedAccumulate(Collection<String> tables)`
`boolean`	`isShardingTable(String logicTableName)` Judge whether logic table is sharding table or not.
`boolean`	`tableRuleExists(Collection<String> logicTableNames)` Judge whether a table rule exists for logic tables.

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

从接口继承的方法 org.apache.shardingsphere.infra.rule.ShardingSphereRule
getConfiguration

- 构造器详细资料
  - ShardingRule
```
public ShardingRule(ShardingRuleConfiguration config,
                    Collection<String> dataSourceNames,
                    org.apache.shardingsphere.infra.instance.InstanceContext instanceContext)
```
  - ShardingRule
```
public ShardingRule(AlgorithmProvidedShardingRuleConfiguration config,
                    Collection<String> dataSourceNames,
                    org.apache.shardingsphere.infra.instance.InstanceContext instanceContext)
```
- 方法详细资料
  - getAllTables
```
public Collection<String> getAllTables()
```
    指定者:
    
    getAllTables 在接口中 org.apache.shardingsphere.infra.rule.identifier.type.DataNodeContainedRule
  - getDatabaseShardingStrategyConfiguration
```
public ShardingStrategyConfiguration getDatabaseShardingStrategyConfiguration(TableRule tableRule)
```
    Get database sharding strategy configuration.
    
    参数:
    
    tableRule - table rule
    
    返回:
    
    database sharding strategy configuration
  - getTableShardingStrategyConfiguration
```
public ShardingStrategyConfiguration getTableShardingStrategyConfiguration(TableRule tableRule)
```
    Get table sharding strategy configuration.
    
    参数:
    
    tableRule - table rule
    
    返回:
    
    table sharding strategy configuration
  - getAuditStrategyConfiguration
```
public ShardingAuditStrategyConfiguration getAuditStrategyConfiguration(TableRule tableRule)
```
    Get audit strategy configuration.
    
    参数:
    
    tableRule - table rule
    
    返回:
    
    audit strategy configuration
  - 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
  - isAllBindingTables
```
public boolean isAllBindingTables(Collection<String> logicTableNames)
```
    Judge whether logic table is all binding tables or not.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    whether logic table is all binding tables or not
  - isAllBindingTables
```
public boolean isAllBindingTables(org.apache.shardingsphere.infra.metadata.database.ShardingSphereDatabase database,
                                  SQLStatementContext<?> sqlStatementContext,
                                  Collection<String> logicTableNames)
```
    Judge whether logic table is all binding tables.
    
    参数:
    
    database - database
    
    sqlStatementContext - sqlStatementContext
    
    logicTableNames - logic table names
    
    返回:
    
    whether logic table is all binding tables
  - 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 whether logic table is all broadcast tables or not.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    whether logic table is all broadcast tables or not
  - isAllShardingTables
```
public boolean isAllShardingTables(Collection<String> logicTableNames)
```
    Judge whether logic table is all sharding table or not.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    whether logic table is all sharding table or not
  - isShardingTable
```
public boolean isShardingTable(String logicTableName)
```
    Judge whether logic table is sharding table or not.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    whether logic table is sharding table or not
  - isBroadcastTable
```
public boolean isBroadcastTable(String logicTableName)
```
    Judge whether logic table is broadcast table or not.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    whether logic table is broadcast table or not
  - isAllTablesInSameDataSource
```
public boolean isAllTablesInSameDataSource(Collection<String> logicTableNames)
```
    Judge whether all tables are in same data source or not.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    whether all tables are in same data source or not
  - tableRuleExists
```
public boolean tableRuleExists(Collection<String> logicTableNames)
```
    Judge whether a table rule exists for logic tables.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    whether a table rule exists for logic tables
  - findShardingColumn
```
public Optional<String> findShardingColumn(String columnName,
                                           String tableName)
```
    Find sharding column.
    
    参数:
    
    columnName - column name
    
    tableName - table name
    
    返回:
    
    sharding column
  - isGenerateKeyColumn
```
public boolean isGenerateKeyColumn(String columnName,
                                   String tableName)
```
    Judge whether given logic table column is generate key column or not.
    
    参数:
    
    columnName - column name
    
    tableName - table name
    
    返回:
    
    whether given logic table column is generate key 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)
```
    Find the Generated key of logic table.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    generated key
  - getDataNode
```
public org.apache.shardingsphere.infra.datanode.DataNode getDataNode(String logicTableName)
```
    Find data node by logic table name.
    
    参数:
    
    logicTableName - logic table name
    
    返回:
    
    data node
  - getShardingLogicTableNames
```
public Collection<String> getShardingLogicTableNames(Collection<String> logicTableNames)
```
    Get sharding logic table names.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    sharding logic table names
  - getShardingRuleTableNames
```
public Collection<String> getShardingRuleTableNames(Collection<String> logicTableNames)
```
    Get sharding rule table names.
    
    参数:
    
    logicTableNames - logic table names
    
    返回:
    
    sharding rule 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
  - getLogicTablesByActualTable
```
public Collection<String> getLogicTablesByActualTable(String actualTable)
```
    Get logic tables via actual table name.
    
    参数:
    
    actualTable - actual table name
    
    返回:
    
    logic tables
  - getAllDataNodes
```
public Map<String,Collection<org.apache.shardingsphere.infra.datanode.DataNode>> getAllDataNodes()
```
    指定者:
    
    getAllDataNodes 在接口中 org.apache.shardingsphere.infra.rule.identifier.type.DataNodeContainedRule
  - getDataNodesByTableName
```
public Collection<org.apache.shardingsphere.infra.datanode.DataNode> getDataNodesByTableName(String tableName)
```
    指定者:
    
    getDataNodesByTableName 在接口中 org.apache.shardingsphere.infra.rule.identifier.type.DataNodeContainedRule
  - findFirstActualTable
```
public Optional<String> findFirstActualTable(String logicTable)
```
    指定者:
    
    findFirstActualTable 在接口中 org.apache.shardingsphere.infra.rule.identifier.type.DataNodeContainedRule
  - isNeedAccumulate
```
public boolean isNeedAccumulate(Collection<String> tables)
```
    指定者:
    
    isNeedAccumulate 在接口中 org.apache.shardingsphere.infra.rule.identifier.type.DataNodeContainedRule
  - findLogicTableByActualTable
```
public Optional<String> findLogicTableByActualTable(String actualTable)
```
    指定者:
    
    findLogicTableByActualTable 在接口中 org.apache.shardingsphere.infra.rule.identifier.type.DataNodeContainedRule
  - getTables
```
public Collection<String> getTables()
```
    指定者:
    
    getTables 在接口中 org.apache.shardingsphere.infra.rule.identifier.type.TableContainedRule
  - findActualTableByCatalog
```
public Optional<String> findActualTableByCatalog(String catalog,
                                                 String logicTable)
```
    指定者:
    
    findActualTableByCatalog 在接口中 org.apache.shardingsphere.infra.rule.identifier.type.DataNodeContainedRule
  - getType
```
public String getType()
```
    指定者:
    
    getType 在接口中 org.apache.shardingsphere.infra.rule.ShardingSphereRule

类 ShardingRule

构造器概要

方法概要

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

从接口继承的方法 org.apache.shardingsphere.infra.rule.ShardingSphereRule

构造器详细资料

ShardingRule

ShardingRule

方法详细资料

getAllTables

getDatabaseShardingStrategyConfiguration

getTableShardingStrategyConfiguration

getAuditStrategyConfiguration

findTableRule

findTableRuleByActualTable

getTableRule

isAllBindingTables

isAllBindingTables

findBindingTableRule

isAllBroadcastTables

isAllShardingTables

isShardingTable

isBroadcastTable

isAllTablesInSameDataSource

tableRuleExists

findShardingColumn

isGenerateKeyColumn

findGenerateKeyColumnName

generateKey

getDataNode

getShardingLogicTableNames

getShardingRuleTableNames

getLogicAndActualTablesFromBindingTable

getLogicTablesByActualTable

getAllDataNodes

getDataNodesByTableName

findFirstActualTable

isNeedAccumulate

findLogicTableByActualTable

getTables

findActualTableByCatalog

getType