org.apache.shardingsphere.shadow.rule

Class ShadowRule

java.lang.Object

org.apache.shardingsphere.shadow.rule.ShadowRule

All Implemented Interfaces:

org.apache.shardingsphere.infra.rule.identifier.scope.SchemaRule, org.apache.shardingsphere.infra.rule.identifier.type.DataSourceContainedRule, org.apache.shardingsphere.infra.rule.ShardingSphereRule

public final class ShadowRule
extends Object
implements org.apache.shardingsphere.infra.rule.identifier.scope.SchemaRule, org.apache.shardingsphere.infra.rule.identifier.type.DataSourceContainedRule

Databases shadow rule.

Constructor Summary

Constructors

Constructor and Description
ShadowRule(AlgorithmProvidedShadowRuleConfiguration shadowRuleConfig)
ShadowRule(ShadowRuleConfiguration shadowRuleConfig)

Method Summary

Modifier and Type	Method and Description
Collection<HintShadowAlgorithm<Comparable<?>>>	getAllHintShadowAlgorithms() Get related hint shadow algorithms.
Map<String,String>	getAllShadowDataSourceMappings() Get all shadow data source mappings.
Collection<String>	getAllShadowTableNames() Get all shadow table names.
Map<String,Collection<String>>	getDataSourceMapper()
Optional<ShadowAlgorithm>	getDefaultShadowAlgorithm() Get default shadow algorithm.
Collection<ColumnShadowAlgorithm<Comparable<?>>>	getRelatedColumnShadowAlgorithms(String tableName, ShadowOperationType shadowOperationType) Get related column shadow algorithms by table name.
Collection<HintShadowAlgorithm<Comparable<?>>>	getRelatedHintShadowAlgorithms(String tableName) Get related hint shadow algorithms by table name.
Map<String,String>	getRelatedShadowDataSourceMappings(String tableName) Get shadow data source mappings.
Collection<String>	getRelatedShadowTables(Collection<String> tableNames) Get related shadow tables.
Optional<String>	getSourceDataSourceName(String actualDataSourceName) Get source data source name.
String	getType()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShadowRule

public ShadowRule(ShadowRuleConfiguration shadowRuleConfig)

ShadowRule

public ShadowRule(AlgorithmProvidedShadowRuleConfiguration shadowRuleConfig)

Method Detail

getDefaultShadowAlgorithm

public Optional<ShadowAlgorithm> getDefaultShadowAlgorithm()

Get default shadow algorithm.

Returns:

shadow algorithm

getRelatedShadowTables

public Collection<String> getRelatedShadowTables(Collection<String> tableNames)

Get related shadow tables.

Parameters:

tableNames - table names

Returns:

related shadow tables

getAllShadowTableNames

public Collection<String> getAllShadowTableNames()

Get all shadow table names.

Returns:

shadow table names

getAllHintShadowAlgorithms

public Collection<HintShadowAlgorithm<Comparable<?>>> getAllHintShadowAlgorithms()

Get related hint shadow algorithms.

Returns:

related hint shadow algorithms

getRelatedHintShadowAlgorithms

public Collection<HintShadowAlgorithm<Comparable<?>>> getRelatedHintShadowAlgorithms(String tableName)

Get related hint shadow algorithms by table name.

Parameters:

tableName - table name

Returns:

hint shadow algorithms

getRelatedColumnShadowAlgorithms

public Collection<ColumnShadowAlgorithm<Comparable<?>>> getRelatedColumnShadowAlgorithms(String tableName,
                                                                                         ShadowOperationType shadowOperationType)

Get related column shadow algorithms by table name.

Parameters:

tableName - table name

shadowOperationType - shadow operation type

Returns:

column shadow algorithms

getRelatedShadowDataSourceMappings

public Map<String,String> getRelatedShadowDataSourceMappings(String tableName)

Get shadow data source mappings.

Parameters:

tableName - table name

Returns:

shadow data source rules

getAllShadowDataSourceMappings

public Map<String,String> getAllShadowDataSourceMappings()

Get all shadow data source mappings.

Returns:

all shadow data source mappings

getSourceDataSourceName

public Optional<String> getSourceDataSourceName(String actualDataSourceName)

Get source data source name.

Parameters:

actualDataSourceName - actual data source name

Returns:

source data source name

getDataSourceMapper

public Map<String,Collection<String>> getDataSourceMapper()

Specified by:

getDataSourceMapper in interface org.apache.shardingsphere.infra.rule.identifier.type.DataSourceContainedRule

getType

public String getType()

Specified by:

getType in interface org.apache.shardingsphere.infra.rule.ShardingSphereRule