Create Data Comparison Task

Creates a data comparison task, including the source and target data sources and the scope of databases and tables to compare.

Request URL: /openapi/v1/comparedata/create

Request Method: POST

Request Parameters

Parameter	Type	Required	Description	Example
name	String	Yes	Task name.	codex-compare-1775716827866
sourceDsId	String	Yes	Source data source ID. You can call Get Data Source List to query it.	ds-d8k4ch8yj9o0
targetDsId	String	Yes	Target data source ID. You can call Get Data Source List to query it.	ds-d8k49pw2xbcf
taskMode	String	Yes	Comparison type. The documented value in the current source is FULL, which means full comparison.	FULL
objectConfig	Object	Yes	Comparison object configuration. See objectConfig Fields.	{ "all": false, "databaseList": [] }

objectConfig Fields

Parameter	Type	Required	Description	Example
all	Boolean	Yes	Whether to select all objects in the instance.	false
databaseList	Array	No	List of databases and objects to compare. Used when all=false. See databaseList Fields.	[{...}]

databaseList Fields

Parameter	Type	Required	Description	Example
databaseName	String	Yes	Source database name.	sample_employees_337
targetDatabase	String	Yes	Target database name.	sample_employees_337
all	Boolean	Yes	Whether to select all tables in the database.	true
tableList	Array	No	List of tables to compare. Used when all=false. See tableList Fields.	[{...}]

tableList Fields

Parameter	Type	Required	Description	Example
tableName	String	Yes	Source table name.	departments
targetTable	String	Yes	Target table name.	departments

Request Example

{
  "name": "codex-compare-1775716827866",
  "sourceDsId": "ds-d8k4ch8yj9o0",
  "targetDsId": "ds-d8k49pw2xbcf",
  "taskMode": "FULL",
  "objectConfig": {
    "all": false,
    "allDatabase": false,
    "databaseList": [
      {
        "all": true,
        "databaseName": "sample_employees_337",
        "ddlTriggerList": [],
        "eventList": [],
        "functionList": [],
        "objectFullName": "sample_employees_337",
        "objectName": "sample_employees_337",
        "objectType": "DATABASE",
        "otherStoredObjectList": [],
        "procedureList": [],
        "tableList": [
          {
            "objectFullName": "departments",
            "objectName": "departments",
            "objectType": "TABLE",
            "tableName": "departments",
            "targetDatabase": "sample_employees_337",
            "targetName": "departments",
            "targetTable": "departments"
          },
          {
            "objectFullName": "dept_emp",
            "objectName": "dept_emp",
            "objectType": "TABLE",
            "tableName": "dept_emp",
            "targetDatabase": "sample_employees_337",
            "targetName": "dept_emp",
            "targetTable": "dept_emp"
          },
          {
            "objectFullName": "dept_manager",
            "objectName": "dept_manager",
            "objectType": "TABLE",
            "tableName": "dept_manager",
            "targetDatabase": "sample_employees_337",
            "targetName": "dept_manager",
            "targetTable": "dept_manager"
          },
          {
            "objectFullName": "employees",
            "objectName": "employees",
            "objectType": "TABLE",
            "tableName": "employees",
            "targetDatabase": "sample_employees_337",
            "targetName": "employees",
            "targetTable": "employees"
          },
          {
            "objectFullName": "salaries",
            "objectName": "salaries",
            "objectType": "TABLE",
            "tableName": "salaries",
            "targetDatabase": "sample_employees_337",
            "targetName": "salaries",
            "targetTable": "salaries"
          }
        ],
        "targetDatabase": "sample_employees_337",
        "targetName": "sample_employees_337",
        "viewList": []
      }
    ],
    "migrateEvent": true,
    "migrateTrigger": true
  }
}

Response Parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request succeeds.	true
requestId	String	Request ID.	Cv8i6FVH-HNNLmSTnNHMj2CDdOGs6YLG
data	String	Data comparison task ID.	cd-td7rupk2ps

Successful Invocation Example

{
  "success": true,
  "requestId": "Cv8i6FVH-HNNLmSTnNHMj2CDdOGs6YLG",
  "data": "cd-td7rupk2ps"
}