org.apache.shardingsphere.data.pipeline.api

Interface RuleAlteredJobAPI

All Superinterfaces:

PipelineJobAPI, org.apache.shardingsphere.spi.required.RequiredSPI, org.apache.shardingsphere.spi.singleton.SingletonSPI

public interface RuleAlteredJobAPI
extends PipelineJobAPI, org.apache.shardingsphere.spi.required.RequiredSPI, org.apache.shardingsphere.spi.singleton.SingletonSPI

Rule altered job API.

Method Summary

Modifier and Type	Method and Description
boolean	aggregateDataConsistencyCheckResults(String jobId, Map<String,DataConsistencyCheckResult> checkResultMap) Aggregate data consistency check results.
Map<String,DataConsistencyCheckResult>	dataConsistencyCheck(JobConfiguration jobConfig) Do data consistency check.
Map<String,DataConsistencyCheckResult>	dataConsistencyCheck(String jobId) Do data consistency check.
Map<String,DataConsistencyCheckResult>	dataConsistencyCheck(String jobId, String algorithmType) Do data consistency check.
JobConfiguration	getJobConfig(String jobId) Get job configuration.
Map<Integer,JobProgress>	getProgress(JobConfiguration jobConfig) Get job progress.
Map<Integer,JobProgress>	getProgress(String jobId) Get job progress.
boolean	isDataConsistencyCheckNeeded(JobConfiguration jobConfig) Is data consistency check needed.
boolean	isDataConsistencyCheckNeeded(String jobId) Is data consistency check needed.
List<JobInfo>	list() List all jobs.
Collection<DataConsistencyCheckAlgorithmInfo>	listDataConsistencyCheckAlgorithms() List all data consistency check algorithms from SPI.
void	reset(String jobId) Reset scaling job.
void	restoreClusterWriteDB(String jobId) Restore cluster write to job source schema's underlying DB.
void	restoreClusterWriteDB(String schemaName, String jobId) Restore cluster write to job source schema's underlying DB.
Optional<String>	start(JobConfiguration jobConfig) Start scaling job by config.
void	stopClusterWriteDB(String jobId) Stop cluster write to job source schema's underlying DB.
void	stopClusterWriteDB(String schemaName, String jobId) Stop cluster write to job source schema's underlying DB.
void	switchClusterConfiguration(JobConfiguration jobConfig) Switch job source schema's configuration to job target configuration.
void	switchClusterConfiguration(String jobId) Switch job source schema's configuration to job target configuration.

Methods inherited from interface org.apache.shardingsphere.data.pipeline.api.PipelineJobAPI

remove, startDisabledJob, stop

Methods inherited from interface org.apache.shardingsphere.spi.required.RequiredSPI

isDefault

Method Detail

list

List<JobInfo> list()

List all jobs.

Returns:

job infos

start

Optional<String> start(JobConfiguration jobConfig)

Start scaling job by config.

Parameters:

jobConfig - job config

Returns:

job id

getProgress

Map<Integer,JobProgress> getProgress(String jobId)

Get job progress.

Parameters:

jobId - job id

Returns:

each sharding item progress

getProgress

Map<Integer,JobProgress> getProgress(JobConfiguration jobConfig)

Get job progress.

Parameters:

jobConfig - job configuration

Returns:

each sharding item progress

stopClusterWriteDB

void stopClusterWriteDB(String jobId)

Stop cluster write to job source schema's underlying DB.

Parameters:

jobId - job id

stopClusterWriteDB

void stopClusterWriteDB(String schemaName,
                        String jobId)

Stop cluster write to job source schema's underlying DB.

Parameters:

schemaName - schema name

jobId - job id

restoreClusterWriteDB

void restoreClusterWriteDB(String jobId)

Restore cluster write to job source schema's underlying DB.

Parameters:

jobId - job id

restoreClusterWriteDB

void restoreClusterWriteDB(String schemaName,
                           String jobId)

Restore cluster write to job source schema's underlying DB.

Parameters:

schemaName - schema name

jobId - job id

listDataConsistencyCheckAlgorithms

Collection<DataConsistencyCheckAlgorithmInfo> listDataConsistencyCheckAlgorithms()

List all data consistency check algorithms from SPI.

Returns:

data consistency check algorithms

isDataConsistencyCheckNeeded

boolean isDataConsistencyCheckNeeded(String jobId)

Is data consistency check needed.

Parameters:

jobId - job id

Returns:

data consistency check needed or not

isDataConsistencyCheckNeeded

boolean isDataConsistencyCheckNeeded(JobConfiguration jobConfig)

Is data consistency check needed.

Parameters:

jobConfig - job configuration

Returns:

data consistency check needed or not

dataConsistencyCheck

Map<String,DataConsistencyCheckResult> dataConsistencyCheck(String jobId)

Do data consistency check.

Parameters:

jobId - job id

Returns:

each logic table check result

dataConsistencyCheck

Map<String,DataConsistencyCheckResult> dataConsistencyCheck(JobConfiguration jobConfig)

Do data consistency check.

Parameters:

jobConfig - job configuration

Returns:

each logic table check result

dataConsistencyCheck

Map<String,DataConsistencyCheckResult> dataConsistencyCheck(String jobId,
                                                            String algorithmType)

Do data consistency check.

Parameters:

jobId - job id

algorithmType - algorithm type

Returns:

each logic table check result

aggregateDataConsistencyCheckResults

boolean aggregateDataConsistencyCheckResults(String jobId,
                                             Map<String,DataConsistencyCheckResult> checkResultMap)

Aggregate data consistency check results.

Parameters:

jobId - job id

checkResultMap - check result map

Returns:

check success or not

switchClusterConfiguration

void switchClusterConfiguration(String jobId)

Switch job source schema's configuration to job target configuration.

Parameters:

jobId - job id

switchClusterConfiguration

void switchClusterConfiguration(JobConfiguration jobConfig)

Switch job source schema's configuration to job target configuration.

Parameters:

jobConfig - job configuration

reset

void reset(String jobId)

Reset scaling job.

Parameters:

jobId - job id

getJobConfig

JobConfiguration getJobConfig(String jobId)

Get job configuration.

Parameters:

jobId - job id

Returns:

job configuration