SubmitPreCheck

This topic describes the SubmitPreCheck API provided by OceanBase Migration Service (OMS) Community Edition.

Overview

You can call this operation to create a precheck task.

API details

Constraints

This interface applies to OMS Community Edition V4.2.12-CE and later.

Request path

POST /api/v2?Action=SubmitPreCheck

Request parameters

• databases/databasesBlack data structure

  Parameter	Type	Description
  mappedName	string	The name of the target database.
  name	string	The name of the source database.
  id	string	The ID of the database.
  tables	array	The list of configurations of the table objects to be transmitted in the current database. When mode is set to WILDCARD, this parameter specifies the configuration of the specific blocklist or allowlist, which applies to tables and views.
  ├─ mappedName	string	The mapped name of the table.
  ├─ name	string	The name of the table.
  ├─ id	string	The ID of the table.
  ├─ whereClause	string	The WHERE clause in a standard SQL statement, which is used to configure row filtering.
  ├─ filterColumns	array	The collection of filtered columns.
  ├─ shardColumns	array	The collection of shard columns.
  views	array	The list of configurations of the view objects to be transmitted in the current database.
  ├─ mappedName	string	The mapped name of the view.
  ├─ name	string	The name of the view.
  ├─ id	string	The ID of the view.
  ├─ whereClause	string	The WHERE clause in a standard SQL statement, which is used to configure row filtering.
  ├─ filterColumns	array	The collection of filtered columns.
  ├─ shardColumns	array	The collection of shard columns.
  specificTables	array	The list of configurations of the specific table objects. When mode is set to WILDCARD, this parameter specifies the renaming and row filtering configurations of the specific table objects.
  ├─ mappedName	string	The mapped name of the table.
  ├─ name	string	The name of the table.
  ├─ id	string	The ID of the table.
  ├─ whereClause	string	The WHERE clause in a standard SQL statement, which is used to configure row filtering.
  ├─ filterColumns	array	The collection of filtered columns.
  ├─ shardColumns	array	The collection of shard columns.
  specificViews	array	The list of configurations of the specific view objects. When mode is set to WILDCARD, this parameter specifies the renaming configuration of the specific view objects.
  ├─ mappedName	string	The mapped name of the view.
  ├─ name	string	The name of the view.
  ├─ id	string	The ID of the view.
  ├─ whereClause	string	The WHERE clause in a standard SQL statement, which is used to configure row filtering.
  ├─ filterColumns	array	The collection of filtered columns.
  ├─ shardColumns	array	The collection of shard columns.
  procedures	array	The list of configurations of stored procedures in the current database.
  ├─ name	string	The name of the stored procedure.
  ├─ mappedName	string	The mapped name of the stored procedure.
  functions	array	The list of configurations of functions in the current database.
  ├─ name	string	The name of the function.
  ├─ mappedName	string	The mapped name of the function.

Response parameters

Examples

Request example

{
    "name":"test",
    "type":"MIGRATION",
    "labelIds":[
        "l_4w****wygjk"
    ],
    "sourceEndpointId":"e_4wg07f****",
    "sinkEndpointId":"e_4wfy2****",
    "transferMapping":{
        "mode":"SPECIFIC",
        "databases":[
            {
                "mappedName":"gez3***",
                "name":"ion1****bmysql",
                "id":null,
                "tables":[
                    {
                        "mappedName":"tion12***20obmysql2",
                        "name":"GRATION129****",
                        "id":null,
                        "whereClause":null,
                        "filterColumns":null,
                        "shardColumns":null,
                    }
                ],
                "views":null,
                "procedures":[
                    {
                        "name": "baxxx_crxxx_user",
                        "mappedName": "baxxx_crxxx_user_rename"
                    }
                ],
                "functions":[
                    {
                        "name": "rand_string",
                        "mappedName": "rand_string_rename"
                    }
                ],
                "specificTables":null,
                "specificViews":null
            }
        ],
        "databasesBlack":null,
        "tableAndViewWhiteList":null,
        "tableAndViewBlackList":null
    },
    "commonTransferConfig":{
        "tableCategory":null,
        "activeActive":false,
        "mqSerializerType":null,
        "mqPartitionMode":null,
        "mqPartition":0,
        "datahubTopicType":null,
        "rocketMqProducerGroup":null,
        "rocketMqMsgTags":null,
        "rocketMqEnableMsgTrace":null,
        "rocketMqSendMsgTimeout":null,
        "dataWorksBusinessName":null
    },
    "enableStructTransfer":true,
    "structTransferConfig":{
        "byteCharConvertStrategy":"DO_NOTHING_IF_BYTE_USED",
        "deferIndexCreation":true,
        "shardsCount": 1,
        "replicasCount": 1,
        "dateFormat": "yyyy-MM-dd HH:mm:ss"
    },
    "enableFullTransfer":true,
    "enableFullVerify":true,
    "fullTransferConfig":{
        "nonePkUkTruncateDstTable":null,
        "allowDestTableNotEmpty":true,
        "fullTransferSpeedMode":"NORMAL",
        "fullVerifySpeedMode":"NORMAL"
    },
    "enableIncrTransfer":true,
    "enableReverseIncrTransfer":true,
    "incrTransferConfig":{
        "startTimestamp":1689201369,
        "recordTypeWhiteList":[
            "DELETE",
            "INSERT",
            "UPDATE"
        ],
        "storeLogKeptHour":120,
        "enableSequencingWithinTxn":true,
        "incrSyncConcurrency":64,
        "enableIncrSyncStatistics":true
    }
}

Response example

{
    "success": true,
    "errorDetail": null,
    "code": null,
    "message": null,
    "advice": null,
    "requestId": "b1854cd****",
    "pageNumber": null,
    "pageSize": null,
    "totalCount": null,
    "cost": "1502 ms",
    "data": "t_7di1uvmxd340"
}