CreateProject

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

Purpose

You can call this operation to create a data migration or synchronization project.

Call description

Limitations

This operation is applicable to OMS Community Edition V4.1.1 and later versions.

Request path

POST /api/v2?Action=CreateProject

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 database ID.
  tables	array	The list of tables in the current database for migration. When the value of mode is set to WILDCARD, the value of this parameter is a blocklist or allowlist of tables and views.
  ├─ mappedName	string	The name of the destination table.
  ├─ name	string	The name of the source table.
  ├─ id	string	The table ID.
  ├─ whereClause	string	A standard SQL WHERE clause used to filter data by row.
  ├─ filterColumns	array	A collection of filter columns.
  ├─ shardColumns	array	A collection of sharding columns.
  ├─ columns		For more information, see the "Parameters in columns" section of this topic.
  views	array	The list of views in the current database for migration.
  ├─ mappedName	string	The name of the destination view.
  ├─ name	string	The name of the source view.
  ├─ id	string	The view ID.
  ├─ whereClause	string	A standard SQL WHERE clause used to filter data by row.
  ├─ filterColumns	array	A collection of filter columns.
  ├─ shardColumns	array	A collection of sharding columns.
  ├─ columns	array	The list of columns for migration. For more information, see the "Parameters in columns" section of this topic.
  specificTables	array	The list of table objects. When the value of mode is set to WILDCARD, the value of this parameter is the renaming or row-based filtering configurations of specific table objects.
  ├─ mappedName	string	The name of the destination table.
  ├─ name	string	The name of the source table.
  ├─ id	string	The table ID.
  ├─ whereClause	string	A standard SQL WHERE clause used to filter data by row.
  ├─ filterColumns	array	A collection of filter columns.
  ├─ shardColumns	array	A collection of sharding columns.
  ├─ columns	array	The list of columns for migration. For more information, see the "Parameters in columns" section of this topic.
  specificViews	array	The list of specific view objects. When the value of mode is set to WILDCARD, the value of this parameter is the renaming configurations of specific view objects.
  ├─ mappedName	string	The name of the destination view.
  ├─ name	string	The name of the source view.
  ├─ id	string	The view ID.
  ├─ whereClause	string	A standard SQL WHERE clause used to filter data by row.
  ├─ filterColumns	array	A collection of filter columns.
  ├─ shardColumns	array	A collection of sharding columns.
  ├─ columns	array	The list of columns for migration. For more information, see the "Parameters in columns" section of this topic.

• Parameters in columns

  Parameter	Type	Description
  type	string	The type. Valid values: DATABASE and TABLE.
  columnName	string	The column name.
  mappedName	string	The name of the destination column.
  position	integer	The position of the parameter.
  columnType	string	The type of the column.
  recordFieldType	string	The derivation of the column type.
  rawColumnType	string	The original string of the column type recorded in the database.
  columnKey	string	The type of the index.
  nullable	boolean	Indicates whether null values are supported.
  defaultValue	string	The default value of the column.
  dataLength	integer	The length of the column.
  dataPrecision	integer	The precision of the column.
  dataScale	integer	The number of decimal places.
  encoding	string	The character encoding format of the column.
  columnComment	string	The comment of the column.
  isGenerateField	boolean	Specifies whether the column is a hidden column.

Return result

Examples

Sample request

{
    "name":"test",
    "type":"MIGRATION",
    "labelIds":[
        "l_4w****wygjk"
    ],
    "sourceEndpointId":"e_4wg07f****",
    "sinkEndpointId":"e_4wfy2****",
    "transferMapping":{
        "mode":"SPECIFIC",
        "databases":[
            {
                "clusterName":null,
                "tenantName":null,
                "mappedName":"gez3***",
                "name":"ion1****bmysql",
                "id":"efetze***",
                "tables":[
                    {
                        "mappedName":"tion12***20obmysql2",
                        "name":"GRATION129****",
                        "id":"dext***",
                        "whereClause":null,
                        "filterColumns":null,
                        "shardColumns":null,
                        "columns":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":{
        "Code":"CM-RES***11",
        "Level":"WARN",
        "Message":"A system error occurred.",
        "Proposal":"Contact the administrator."
    },
    "Code":"INNER_ERROR",
    "Message":"A system error occurred.",
    "Advice":"Contact the administrator.",
    "RequestId":"XCVSADG****DSGDS",
    "PageNumber":1,
    "PageSize":1,
    "TotalCount":1,
    "Cost":"27 ms",
    "Data":"np_****"
}