SubmitPreCheck

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

Purpose

You can call this operation to perform a precheck on a data migration or synchronization project.

Call description

Prerequisites

This operation is supported in OMS V4.2.2 and later.

Request path

POST /api/v2?Action=SubmitPreCheck

Request parameters

• Parameters in databases/databasesBlack

  Parameter	Type	Description
  mappedName	String	The name of the destination database.
  name	String	The name of the source database.
  id	String	The ID of the database.
  tables	Array	The settings for the table objects to be transferred in the current database. When the mode parameter is set to WILDCARD, this parameter indicates the settings for a specific blocklist or allowlist of tables and views.
  ├─ mappedName	String	The mapped table name.
  ├─ name	String	The name of the table.
  ├─ id	String	The ID of the table.
  ├─ whereClause	String	The WHERE clause in the standard SQL syntax that is used to configure row filtering.
  ├─ filterColumns	Array	The filter columns.
  ├─ shardColumns	Array	The sharding columns.
  views	Array	The settings for the view objects to be transferred in the current database.
  ├─ mappedName	String	The mapped view name.
  ├─ name	String	The name of the view.
  ├─ id	String	The ID of the view.
  ├─ whereClause	String	The WHERE clause in the standard SQL syntax that is used to configure row filtering.
  ├─ filterColumns	Array	The filter columns.
  ├─ shardColumns	Array	The sharding columns.
  specificTables	Array	The settings for the matched table objects. When the mode parameter is set to WILDCARD, this parameter indicates the rename and row filtering settings for the matched table objects.
  ├─ mappedName	String	The mapped table name.
  ├─ name	String	The name of the table.
  ├─ id	String	The ID of the table.
  ├─ whereClause	String	The WHERE clause in the standard SQL syntax that is used to configure row filtering.
  ├─ filterColumns	Array	The filter columns.
  ├─ shardColumns	Array	The sharding columns.
  specificViews	Array	The settings for the matched view objects. When the mode parameter is set to WILDCARD, this parameter indicates the rename settings for the matched view objects.
  ├─ mappedName	String	The mapped view name.
  ├─ name	String	The name of the view.
  ├─ id	String	The ID of the view.
  ├─ whereClause	String	The WHERE clause in the standard SQL syntax that is used to configure row filtering.
  ├─ filterColumns	Array	The filter columns.
  ├─ shardColumns	Array	The sharding columns.

Response parameters

Examples

Sample request

{
    "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,
                "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
    },
    "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
    }
}

Sample response

{
    "success": true,
    "errorDetail": null,
    "code": null,
    "message": null,
    "advice": null,
    "requestId": "bf2-9bc9-****",
    "pageNumber": null,
    "pageSize": null,
    "totalCount": null,
    "cost": "269 ms",
    "data": "t_57p****"
}