MigrationJobAPIImpl (shardingsphere-data-pipeline-core 5.2.0 API)

java.lang.Object
- org.apache.shardingsphere.data.pipeline.core.api.impl.AbstractPipelineJobAPIImpl
- - org.apache.shardingsphere.data.pipeline.scenario.migration.MigrationJobAPIImpl

所有已实现的接口:

MigrationJobPublicAPI, PipelineJobPublicAPI, PipelineJobAPI, PipelineJobItemAPI, MigrationJobAPI, org.apache.shardingsphere.infra.util.spi.type.required.RequiredSPI, org.apache.shardingsphere.infra.util.spi.type.typed.TypedSPI
```
public final class MigrationJobAPIImpl
extends AbstractPipelineJobAPIImpl
implements MigrationJobAPI
```
Migration job API impl.

字段概要
- 从类继承的字段 org.apache.shardingsphere.data.pipeline.core.api.impl.AbstractPipelineJobAPIImpl
  DATE_TIME_FORMATTER

构造器概要

构造器
构造器和说明

MigrationJobAPIImpl()

构造器
构造器和说明
`MigrationJobAPIImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addMigrationSourceResources(Map<String,DataSourceProperties> dataSourcePropsMap)`
`boolean`	`aggregateDataConsistencyCheckResults(String jobId, Map<String,DataConsistencyCheckResult> checkResults)` Aggregate data consistency check results.
`MigrationProcessContext`	`buildPipelineProcessContext(PipelineJobConfiguration pipelineJobConfig)` Build pipeline process context.
`TaskConfiguration`	`buildTaskConfiguration(PipelineJobConfiguration pipelineJobConfig, int jobShardingItem, PipelineProcessConfiguration pipelineProcessConfig)` Build task configuration.
`protected void`	`cleanTempTableOnRollback(String jobId)`
`String`	`createJobAndStart(CreateMigrationJobParameter parameter)`
`Map<String,DataConsistencyCheckResult>`	`dataConsistencyCheck(MigrationJobConfiguration jobConfig)` Do data consistency check.
`Map<String,DataConsistencyCheckResult>`	`dataConsistencyCheck(String jobId)`
`Map<String,DataConsistencyCheckResult>`	`dataConsistencyCheck(String jobId, String algorithmType, Properties algorithmProps)`
`void`	`dropMigrationSourceResources(Collection<String> resourceNames)`
`void`	`extendYamlJobConfiguration(YamlPipelineJobConfiguration yamlJobConfig)` Extend YAML job configuration.
`protected MigrationJobConfiguration`	`getJobConfiguration(org.apache.shardingsphere.elasticjob.infra.pojo.JobConfigurationPOJO jobConfigPOJO)`
`MigrationJobConfiguration`	`getJobConfiguration(String jobId)` Get job configuration.
`protected MigrationJobInfo`	`getJobInfo(String jobId)`
`InventoryIncrementalJobItemProgress`	`getJobItemProgress(String jobId, int shardingItem)` Get job item progress.
`Map<Integer,InventoryIncrementalJobItemProgress>`	`getJobProgress(MigrationJobConfiguration jobConfig)` Get job progress.
`Map<Integer,InventoryIncrementalJobItemProgress>`	`getJobProgress(String jobId)`
`protected JobType`	`getJobType()`
`List<MigrationJobInfo>`	`list()`
`Collection<DataConsistencyCheckAlgorithmInfo>`	`listDataConsistencyCheckAlgorithms()`
`Collection<Collection<Object>>`	`listMigrationSourceResources()`
`protected String`	`marshalJobIdLeftPart(PipelineJobId pipelineJobId)`
`void`	`persistJobItemProgress(PipelineJobItemContext jobItemContext)` Persist job item progress.
`protected YamlPipelineJobConfiguration`	`swapToYamlJobConfiguration(PipelineJobConfiguration jobConfig)`
`void`	`updateJobItemStatus(String jobId, int shardingItem, JobStatus status)` Update job item status.

从类继承的方法 org.apache.shardingsphere.data.pipeline.core.api.impl.AbstractPipelineJobAPIImpl
alterProcessConfiguration, checkModeConfig, commit, createProcessConfiguration, dropProcessConfiguration, fillJobInfo, getElasticJobConfigPOJO, getType, marshalJobId, rollback, showProcessConfiguration, start, startDisabledJob, stop

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

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

从接口继承的方法 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

- 构造器详细资料
  - MigrationJobAPIImpl
```
public MigrationJobAPIImpl()
```
- 方法详细资料
  - getJobType
```
protected JobType getJobType()
```
    指定者:
    
    getJobType 在类中 AbstractPipelineJobAPIImpl
  - marshalJobIdLeftPart
```
protected String marshalJobIdLeftPart(PipelineJobId pipelineJobId)
```
    指定者:
    
    marshalJobIdLeftPart 在类中 AbstractPipelineJobAPIImpl
  - list
```
public List<MigrationJobInfo> list()
```
    指定者:
    
    list 在接口中 MigrationJobPublicAPI
    
    指定者:
    
    list 在接口中 PipelineJobPublicAPI
    
    覆盖:
    
    list 在类中 AbstractPipelineJobAPIImpl
  - getJobInfo
```
protected MigrationJobInfo getJobInfo(String jobId)
```
    指定者:
    
    getJobInfo 在类中 AbstractPipelineJobAPIImpl
  - extendYamlJobConfiguration
```
public void extendYamlJobConfiguration(YamlPipelineJobConfiguration yamlJobConfig)
```
    从接口复制的说明: PipelineJobAPI
    
    Extend YAML job configuration.
    
    指定者:
    
    extendYamlJobConfiguration 在接口中 PipelineJobAPI
    
    参数:
    
    yamlJobConfig - YAML job configuration
  - swapToYamlJobConfiguration
```
protected YamlPipelineJobConfiguration swapToYamlJobConfiguration(PipelineJobConfiguration jobConfig)
```
    指定者:
    
    swapToYamlJobConfiguration 在类中 AbstractPipelineJobAPIImpl
  - getJobConfiguration
```
public MigrationJobConfiguration getJobConfiguration(String jobId)
```
    从接口复制的说明: PipelineJobAPI
    
    Get job configuration.
    
    指定者:
    
    getJobConfiguration 在接口中 PipelineJobAPI
    
    指定者:
    
    getJobConfiguration 在接口中 MigrationJobAPI
    
    参数:
    
    jobId - job id
    
    返回:
    
    job configuration
  - getJobConfiguration
```
protected MigrationJobConfiguration getJobConfiguration(org.apache.shardingsphere.elasticjob.infra.pojo.JobConfigurationPOJO jobConfigPOJO)
```
    指定者:
    
    getJobConfiguration 在类中 AbstractPipelineJobAPIImpl
  - buildTaskConfiguration
```
public TaskConfiguration buildTaskConfiguration(PipelineJobConfiguration pipelineJobConfig,
                                                int jobShardingItem,
                                                PipelineProcessConfiguration pipelineProcessConfig)
```
    从接口复制的说明: PipelineJobAPI
    
    Build task configuration.
    
    指定者:
    
    buildTaskConfiguration 在接口中 PipelineJobAPI
    
    参数:
    
    pipelineJobConfig - pipeline job configuration
    
    jobShardingItem - job sharding item
    
    pipelineProcessConfig - pipeline process configuration
    
    返回:
    
    task configuration
  - buildPipelineProcessContext
```
public MigrationProcessContext buildPipelineProcessContext(PipelineJobConfiguration pipelineJobConfig)
```
    从接口复制的说明: PipelineJobAPI
    
    Build pipeline process context.
    
    指定者:
    
    buildPipelineProcessContext 在接口中 PipelineJobAPI
    
    指定者:
    
    buildPipelineProcessContext 在接口中 MigrationJobAPI
    
    参数:
    
    pipelineJobConfig - pipeline job configuration
    
    返回:
    
    pipeline process context
  - getJobProgress
```
public Map<Integer,InventoryIncrementalJobItemProgress> getJobProgress(String jobId)
```
    指定者:
    
    getJobProgress 在接口中 MigrationJobPublicAPI
  - getJobProgress
```
public Map<Integer,InventoryIncrementalJobItemProgress> getJobProgress(MigrationJobConfiguration jobConfig)
```
    从接口复制的说明: MigrationJobAPI
    
    Get job progress.
    
    指定者:
    
    getJobProgress 在接口中 MigrationJobAPI
    
    参数:
    
    jobConfig - job configuration
    
    返回:
    
    each sharding item progress
  - getJobItemProgress
```
public InventoryIncrementalJobItemProgress getJobItemProgress(String jobId,
                                                              int shardingItem)
```
    从接口复制的说明: PipelineJobItemAPI
    
    Get job item progress.
    
    指定者:
    
    getJobItemProgress 在接口中 PipelineJobItemAPI
    
    指定者:
    
    getJobItemProgress 在接口中 MigrationJobAPI
    
    参数:
    
    jobId - job id
    
    shardingItem - sharding item
    
    返回:
    
    job item progress, may be null
  - persistJobItemProgress
```
public void persistJobItemProgress(PipelineJobItemContext jobItemContext)
```
    从接口复制的说明: PipelineJobItemAPI
    
    Persist job item progress.
    
    指定者:
    
    persistJobItemProgress 在接口中 PipelineJobItemAPI
    
    参数:
    
    jobItemContext - job item context
  - updateJobItemStatus
```
public void updateJobItemStatus(String jobId,
                                int shardingItem,
                                JobStatus status)
```
    从接口复制的说明: PipelineJobItemAPI
    
    Update job item status.
    
    指定者:
    
    updateJobItemStatus 在接口中 PipelineJobItemAPI
    
    参数:
    
    jobId - job id
    
    shardingItem - sharding item
    
    status - status
  - listDataConsistencyCheckAlgorithms
```
public Collection<DataConsistencyCheckAlgorithmInfo> listDataConsistencyCheckAlgorithms()
```
    指定者:
    
    listDataConsistencyCheckAlgorithms 在接口中 MigrationJobPublicAPI
  - dataConsistencyCheck
```
public Map<String,DataConsistencyCheckResult> dataConsistencyCheck(String jobId)
```
    指定者:
    
    dataConsistencyCheck 在接口中 MigrationJobPublicAPI
  - dataConsistencyCheck
```
public Map<String,DataConsistencyCheckResult> dataConsistencyCheck(MigrationJobConfiguration jobConfig)
```
    从接口复制的说明: MigrationJobAPI
    
    Do data consistency check.
    
    指定者:
    
    dataConsistencyCheck 在接口中 MigrationJobAPI
    
    参数:
    
    jobConfig - job configuration
    
    返回:
    
    each logic table check result
  - dataConsistencyCheck
```
public Map<String,DataConsistencyCheckResult> dataConsistencyCheck(String jobId,
                                                                   String algorithmType,
                                                                   Properties algorithmProps)
```
    指定者:
    
    dataConsistencyCheck 在接口中 MigrationJobPublicAPI
  - aggregateDataConsistencyCheckResults
```
public boolean aggregateDataConsistencyCheckResults(String jobId,
                                                    Map<String,DataConsistencyCheckResult> checkResults)
```
    从接口复制的说明: MigrationJobAPI
    
    Aggregate data consistency check results.
    
    指定者:
    
    aggregateDataConsistencyCheckResults 在接口中 MigrationJobAPI
    
    参数:
    
    jobId - job id
    
    checkResults - check results
    
    返回:
    
    check success or not
  - cleanTempTableOnRollback
```
protected void cleanTempTableOnRollback(String jobId)
                                 throws SQLException
```
    指定者:
    
    cleanTempTableOnRollback 在类中 AbstractPipelineJobAPIImpl
    
    抛出:
    
    SQLException
  - addMigrationSourceResources
```
public void addMigrationSourceResources(Map<String,DataSourceProperties> dataSourcePropsMap)
```
    指定者:
    
    addMigrationSourceResources 在接口中 MigrationJobPublicAPI
  - dropMigrationSourceResources
```
public void dropMigrationSourceResources(Collection<String> resourceNames)
```
    指定者:
    
    dropMigrationSourceResources 在接口中 MigrationJobPublicAPI
  - listMigrationSourceResources
```
public Collection<Collection<Object>> listMigrationSourceResources()
```
    指定者:
    
    listMigrationSourceResources 在接口中 MigrationJobPublicAPI
  - createJobAndStart
```
public String createJobAndStart(CreateMigrationJobParameter parameter)
```
    指定者:
    
    createJobAndStart 在接口中 MigrationJobPublicAPI

类 MigrationJobAPIImpl

字段概要

从类继承的字段 org.apache.shardingsphere.data.pipeline.core.api.impl.AbstractPipelineJobAPIImpl

构造器概要

方法概要

从类继承的方法 org.apache.shardingsphere.data.pipeline.core.api.impl.AbstractPipelineJobAPIImpl

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

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

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

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

构造器详细资料

MigrationJobAPIImpl

方法详细资料

getJobType

marshalJobIdLeftPart

list

getJobInfo

extendYamlJobConfiguration

swapToYamlJobConfiguration

getJobConfiguration

getJobConfiguration

buildTaskConfiguration

buildPipelineProcessContext

getJobProgress

getJobProgress

getJobItemProgress

persistJobItemProgress

updateJobItemStatus

listDataConsistencyCheckAlgorithms

dataConsistencyCheck

dataConsistencyCheck

dataConsistencyCheck

aggregateDataConsistencyCheckResults

cleanTempTableOnRollback

addMigrationSourceResources

dropMigrationSourceResources

listMigrationSourceResources

createJobAndStart