ShardingRule (shardingsphere-sharding-core 5.0.0-beta API)

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

All Implemented Interfaces:

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

Constructor Summary

Constructors
Constructor and Description
`ShardingRule(AlgorithmProvidedShardingRuleConfiguration config, org.apache.shardingsphere.infra.database.type.DatabaseType databaseType, Map<String,DataSource> dataSourceMap)`
`ShardingRule(ShardingRuleConfiguration config, org.apache.shardingsphere.infra.database.type.DatabaseType databaseType, Map<String,DataSource> dataSourceMap)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createSingleTable(org.apache.shardingsphere.infra.metadata.schema.refresher.event.CreateTableEvent event)` Add single table.
`void`	`dropSingleTable(org.apache.shardingsphere.infra.metadata.schema.refresher.event.DropTableEvent event)` Drop single table.
`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<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.
`Collection<String>`	`getAllActualTables()`
`Map<String,Collection<org.apache.shardingsphere.infra.datanode.DataNode>>`	`getAllDataNodes()`
`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.
`Map<String,String>`	`getLogicAndActualTablesFromBindingTable(String dataSourceName, String logicTable, String actualTable, Collection<String> availableLogicBindingTables)` Get logic and actual binding tables.
`Collection<String>`	`getShardingLogicTableNames(Collection<String> logicTableNames)` Get sharding logic table names.
`TableRule`	`getTableRule(String logicTableName)` Get table rule.
`Collection<String>`	`getTables()`
`ShardingStrategyConfiguration`	`getTableShardingStrategyConfiguration(TableRule tableRule)` Get table sharding strategy configuration.
`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`	`isAllShardingTables(Collection<String> logicTableNames)` Judge logic tables is all belong to sharding tables.
`boolean`	`isAllTablesInSameDataSource(Collection<String> logicTableNames)` Judge whether all tables are in same data source or not.
`boolean`	`isBroadcastTable(String logicTableName)` Judge logic table is belong to broadcast tables.
`boolean`	`isGenerateKeyColumn(String columnName, String tableName)` Judge is generate key column or not.
`boolean`	`isNeedAccumulate(Collection<String> tables)`
`boolean`	`isShardingColumn(String columnName, String tableName)` Judge is sharding column or not.
`boolean`	`isShardingTable(String logicTableName)` Judge logic table is belong to sharding tables.
`boolean`	`isSingleTablesInSameDataSource(Collection<String> logicTableNames)` Judge if all single tables exist in same data source.
`boolean`	`singleTableRuleExists(Collection<String> logicTableNames)` Judge if single table rule exists or not.
`boolean`	`tableRuleExists(Collection<String> logicTableNames)` Judge if there is at least one table rule for logic tables.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ShardingRule
```
public ShardingRule(ShardingRuleConfiguration config,
                    org.apache.shardingsphere.infra.database.type.DatabaseType databaseType,
                    Map<String,DataSource> dataSourceMap)
```
  - ShardingRule
```
public ShardingRule(AlgorithmProvidedShardingRuleConfiguration config,
                    org.apache.shardingsphere.infra.database.type.DatabaseType databaseType,
                    Map<String,DataSource> dataSourceMap)
```
- Method Detail
  - getDatabaseShardingStrategyConfiguration
```
public ShardingStrategyConfiguration getDatabaseShardingStrategyConfiguration(TableRule tableRule)
```
    Get database sharding strategy configuration.
    
    Parameters:
    
    tableRule - table rule
    
    Returns:
    
    database sharding strategy configuration
  - getTableShardingStrategyConfiguration
```
public ShardingStrategyConfiguration getTableShardingStrategyConfiguration(TableRule tableRule)
```
    Get table sharding strategy configuration.
    
    Parameters:
    
    tableRule - table rule
    
    Returns:
    
    table sharding strategy configuration
  - findTableRule
```
public Optional<TableRule> findTableRule(String logicTableName)
```
    Find table rule.
    
    Parameters:
    
    logicTableName - logic table name
    
    Returns:
    
    table rule
  - findTableRuleByActualTable
```
public Optional<TableRule> findTableRuleByActualTable(String actualTableName)
```
    Find table rule via actual table name.
    
    Parameters:
    
    actualTableName - actual table name
    
    Returns:
    
    table rule
  - getTableRule
```
public TableRule getTableRule(String logicTableName)
```
    Get table rule.
    
    Parameters:
    
    logicTableName - logic table name
    
    Returns:
    
    table rule
  - isAllBindingTables
```
public boolean isAllBindingTables(Collection<String> logicTableNames)
```
    Judge logic tables is all belong to binding encryptors.
    
    Parameters:
    
    logicTableNames - logic table names
    
    Returns:
    
    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.
    
    Parameters:
    
    logicTableName - logic table name
    
    Returns:
    
    binding table rule
  - isAllBroadcastTables
```
public boolean isAllBroadcastTables(Collection<String> logicTableNames)
```
    Judge logic tables is all belong to broadcast encryptors.
    
    Parameters:
    
    logicTableNames - logic table names
    
    Returns:
    
    logic tables is all belong to broadcast encryptors or not
  - isAllShardingTables
```
public boolean isAllShardingTables(Collection<String> logicTableNames)
```
    Judge logic tables is all belong to sharding tables.
    
    Parameters:
    
    logicTableNames - logic table names
    
    Returns:
    
    logic tables is all belong to sharding tables or not
  - isShardingTable
```
public boolean isShardingTable(String logicTableName)
```
    Judge logic table is belong to sharding tables.
    
    Parameters:
    
    logicTableName - logic table name
    
    Returns:
    
    logic table is belong to sharding tables or not
  - isBroadcastTable
```
public boolean isBroadcastTable(String logicTableName)
```
    Judge logic table is belong to broadcast tables.
    
    Parameters:
    
    logicTableName - logic table name
    
    Returns:
    
    logic table is belong to broadcast tables or not
  - isSingleTablesInSameDataSource
```
public boolean isSingleTablesInSameDataSource(Collection<String> logicTableNames)
```
    Judge if all single tables exist in same data source.
    
    Parameters:
    
    logicTableNames - logic table names
    
    Returns:
    
    all single tables exist in same data source or not
  - isAllTablesInSameDataSource
```
public boolean isAllTablesInSameDataSource(Collection<String> logicTableNames)
```
    Judge whether all tables are in same data source or not.
    
    Parameters:
    
    logicTableNames - logic table names
    
    Returns:
    
    whether all tables are in same data source or not
  - tableRuleExists
```
public boolean tableRuleExists(Collection<String> logicTableNames)
```
    Judge if there is at least one table rule for logic tables.
    
    Parameters:
    
    logicTableNames - logic table names
    
    Returns:
    
    whether a table rule exists for logic tables
  - singleTableRuleExists
```
public boolean singleTableRuleExists(Collection<String> logicTableNames)
```
    Judge if single table rule exists or not.
    
    Parameters:
    
    logicTableNames - logic table names
    
    Returns:
    
    whether single table rule exists for logic tables
  - isShardingColumn
```
public boolean isShardingColumn(String columnName,
                                String tableName)
```
    Judge is sharding column or not.
    
    Parameters:
    
    columnName - column name
    
    tableName - table name
    
    Returns:
    
    is sharding column or not
  - isGenerateKeyColumn
```
public boolean isGenerateKeyColumn(String columnName,
                                   String tableName)
```
    Judge is generate key column or not.
    
    Parameters:
    
    columnName - column name
    
    tableName - table name
    
    Returns:
    
    is generate key column or not
  - findGenerateKeyColumnName
```
public Optional<String> findGenerateKeyColumnName(String logicTableName)
```
    Find column name of generated key.
    
    Parameters:
    
    logicTableName - logic table name
    
    Returns:
    
    column name of generated key
  - generateKey
```
public Comparable<?> generateKey(String logicTableName)
```
    Generate key.
    
    Parameters:
    
    logicTableName - logic table name
    
    Returns:
    
    generated key
  - getDataNode
```
public org.apache.shardingsphere.infra.datanode.DataNode getDataNode(String logicTableName)
```
    Find data node by logic table name.
    
    Parameters:
    
    logicTableName - logic table name
    
    Returns:
    
    data node
  - getShardingLogicTableNames
```
public Collection<String> getShardingLogicTableNames(Collection<String> logicTableNames)
```
    Get sharding logic table names.
    
    Parameters:
    
    logicTableNames - logic table names
    
    Returns:
    
    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.
    
    Parameters:
    
    dataSourceName - data source name
    
    logicTable - logic table name
    
    actualTable - actual table name
    
    availableLogicBindingTables - available logic binding table names
    
    Returns:
    
    logic and actual binding tables
  - createSingleTable
```
public void createSingleTable(org.apache.shardingsphere.infra.metadata.schema.refresher.event.CreateTableEvent event)
```
    Add single table.
    
    Parameters:
    
    event - create table event
  - dropSingleTable
```
public void dropSingleTable(org.apache.shardingsphere.infra.metadata.schema.refresher.event.DropTableEvent event)
```
    Drop single table.
    
    Parameters:
    
    event - drop table event
  - getAllDataNodes
```
public Map<String,Collection<org.apache.shardingsphere.infra.datanode.DataNode>> getAllDataNodes()
```
    Specified by:
    
    getAllDataNodes in interface org.apache.shardingsphere.infra.rule.type.DataNodeContainedRule
  - getAllActualTables
```
public Collection<String> getAllActualTables()
```
    Specified by:
    
    getAllActualTables in interface org.apache.shardingsphere.infra.rule.type.DataNodeContainedRule
  - findFirstActualTable
```
public Optional<String> findFirstActualTable(String logicTable)
```
    Specified by:
    
    findFirstActualTable in interface org.apache.shardingsphere.infra.rule.type.DataNodeContainedRule
  - isNeedAccumulate
```
public boolean isNeedAccumulate(Collection<String> tables)
```
    Specified by:
    
    isNeedAccumulate in interface org.apache.shardingsphere.infra.rule.type.DataNodeContainedRule
  - findLogicTableByActualTable
```
public Optional<String> findLogicTableByActualTable(String actualTable)
```
    Specified by:
    
    findLogicTableByActualTable in interface org.apache.shardingsphere.infra.rule.type.DataNodeContainedRule
  - getTables
```
public Collection<String> getTables()
```
    Specified by:
    
    getTables in interface org.apache.shardingsphere.infra.rule.type.TableContainedRule
  - findActualTableByCatalog
```
public Optional<String> findActualTableByCatalog(String catalog,
                                                 String logicTable)
```
    Specified by:
    
    findActualTableByCatalog in interface org.apache.shardingsphere.infra.rule.type.DataNodeContainedRule

Class ShardingRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShardingRule

ShardingRule

Method Detail

getDatabaseShardingStrategyConfiguration

getTableShardingStrategyConfiguration

findTableRule

findTableRuleByActualTable

getTableRule

isAllBindingTables

findBindingTableRule

isAllBroadcastTables

isAllShardingTables

isShardingTable

isBroadcastTable

isSingleTablesInSameDataSource

isAllTablesInSameDataSource

tableRuleExists

singleTableRuleExists

isShardingColumn

isGenerateKeyColumn

findGenerateKeyColumnName

generateKey

getDataNode

getShardingLogicTableNames

getLogicAndActualTablesFromBindingTable

createSingleTable

dropSingleTable

getAllDataNodes

getAllActualTables

findFirstActualTable

isNeedAccumulate

findLogicTableByActualTable

getTables

findActualTableByCatalog