org.apache.shardingsphere.data.pipeline.scenario.migration

接口 MigrationJobAPI

所有超级接口:

MigrationJobPublicAPI, PipelineJobAPI, PipelineJobItemAPI, PipelineJobPublicAPI, org.apache.shardingsphere.infra.util.spi.type.required.RequiredSPI, org.apache.shardingsphere.infra.util.spi.type.typed.TypedSPI

所有已知实现类:

MigrationJobAPIImpl

public interface MigrationJobAPI
extends PipelineJobAPI, MigrationJobPublicAPI, org.apache.shardingsphere.infra.util.spi.type.required.RequiredSPI

Migration job API.

方法概要

限定符和类型	方法和说明
boolean	aggregateDataConsistencyCheckResults(String jobId, Map<String,DataConsistencyCheckResult> checkResults) Aggregate data consistency check results.
MigrationProcessContext	buildPipelineProcessContext(PipelineJobConfiguration pipelineJobConfig) Build pipeline process context.
Map<String,DataConsistencyCheckResult>	dataConsistencyCheck(MigrationJobConfiguration jobConfig) Do data consistency check.
MigrationJobConfiguration	getJobConfiguration(String jobId) Get job configuration.
InventoryIncrementalJobItemProgress	getJobItemProgress(String jobId, int shardingItem) Get job item progress.
Map<Integer,InventoryIncrementalJobItemProgress>	getJobProgress(MigrationJobConfiguration jobConfig) Get job progress.

从接口继承的方法 org.apache.shardingsphere.data.pipeline.core.api.PipelineJobAPI

buildTaskConfiguration, extendYamlJobConfiguration, marshalJobId, start

从接口继承的方法 org.apache.shardingsphere.data.pipeline.core.api.PipelineJobItemAPI

persistJobItemProgress, updateJobItemStatus

从接口继承的方法 org.apache.shardingsphere.data.pipeline.api.MigrationJobPublicAPI

addMigrationSourceResources, createJobAndStart, dataConsistencyCheck, dataConsistencyCheck, dropMigrationSourceResources, getJobProgress, list, listDataConsistencyCheckAlgorithms, listMigrationSourceResources

从接口继承的方法 org.apache.shardingsphere.data.pipeline.api.PipelineJobPublicAPI

alterProcessConfiguration, commit, createProcessConfiguration, dropProcessConfiguration, rollback, showProcessConfiguration, startDisabledJob, stop

从接口继承的方法 org.apache.shardingsphere.infra.util.spi.type.required.RequiredSPI

isDefault

方法详细资料

getJobConfiguration

MigrationJobConfiguration getJobConfiguration(String jobId)

从接口复制的说明: PipelineJobAPI

Get job configuration.

指定者:

getJobConfiguration 在接口中 PipelineJobAPI

参数:

jobId - job id

返回:

job configuration

buildPipelineProcessContext

MigrationProcessContext buildPipelineProcessContext(PipelineJobConfiguration pipelineJobConfig)

从接口复制的说明: PipelineJobAPI

Build pipeline process context.

指定者:

buildPipelineProcessContext 在接口中 PipelineJobAPI

参数:

pipelineJobConfig - pipeline job configuration

返回:

pipeline process context

getJobProgress

Map<Integer,InventoryIncrementalJobItemProgress> getJobProgress(MigrationJobConfiguration jobConfig)

Get job progress.

参数:

jobConfig - job configuration

返回:

each sharding item progress

getJobItemProgress

InventoryIncrementalJobItemProgress getJobItemProgress(String jobId,
                                                       int shardingItem)

从接口复制的说明: PipelineJobItemAPI

Get job item progress.

指定者:

getJobItemProgress 在接口中 PipelineJobItemAPI

参数:

jobId - job id

shardingItem - sharding item

返回:

job item progress, may be null

dataConsistencyCheck

Map<String,DataConsistencyCheckResult> dataConsistencyCheck(MigrationJobConfiguration jobConfig)

Do data consistency check.

参数:

jobConfig - job configuration

返回:

each logic table check result

aggregateDataConsistencyCheckResults

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

Aggregate data consistency check results.

参数:

jobId - job id

checkResults - check results

返回:

check success or not