创建数据库结构化导入任务

从数据库连接器中选择表、集合或其他支持的对象，将其中数据写入目标表。

POST https://moi.matrixorigin.cn/newmoi/task

调用前准备

准备有目标工作区访问权限的个人访问令牌、目标工作区 ID、支持结构化导入的数据库连接器、来源对象、目标表或目标数据库，以及字段映射生成结果中的 proof hash 和 capability profile hash。

请求体

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$IDEMPOTENCY_KEY 和示例中的资源 ID、来源对象、哈希值替换为实际值。

curl -X POST "https://moi.matrixorigin.cn/newmoi/task" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d @- <<EOF
{
    "config_type": 3,
    "name": "orders-once",
    "structured_load_config": {
      "version": 1,
      "source": {"connector_id": "$CONNECTOR_ID","source_type": "SOURCE_TYPE_MYSQL","database": "sales","table": "orders"},
      "target": {"mode": "existing","database_id": "$DATABASE_ID","table_id": "$TARGET_TABLE_ID"},
      "mapping": [{"source": {"kind": "column","column": "order_id"},"target_column": "order_id","target_type": "BIGINT","nullable": false,"primary_key": true,"allow_duplicate_source": false}],
      "load_policy": {"run_mode": "once","initial_load_rule": "append","conflict_policy": "fail","max_rows_per_batch": 10000},
      "compute": {"task_compute_resource_id": "default","query_compute_resource_id": "default","priority": "normal"},
      "consistency_contract": {"contract_kind": "worker_proved_persistent_watermark","proof_kind": "db_metadata","proof_hash": "$PROOF_HASH","capability_profile_hash": "$CAPABILITY_PROFILE_HASH"}
    }
  }
EOF

在 target 中将 mode 设为 new，并填写新建表的数据库、名称和列定义；其余来源、映射、策略、计算资源和一致性契约字段与上一场景相同。

curl -X POST "https://moi.matrixorigin.cn/newmoi/task" -H "X-API-Key: $AI_STUDIO_API_KEY" -H "X-Workspace-ID: $WORKSPACE_ID" -H "Idempotency-Key: $IDEMPOTENCY_KEY" -H "Content-Type: application/json" -d @- <<EOF
{"config_type":3,"structured_load_config":{"version":1,"source":{"connector_id":"$CONNECTOR_ID","source_type":"SOURCE_TYPE_MYSQL","database":"sales","table":"orders"},"target":{"mode":"new","database_id":"$DATABASE_ID","table_name":"orders_copy","create_table":{"name":"orders_copy","columns":[{"name":"order_id","data_type":"BIGINT","primary_key":true,"nullable":false}]}},"mapping":[{"source":{"kind":"column","column":"order_id"},"target_column":"order_id","target_type":"BIGINT","nullable":false,"primary_key":true,"allow_duplicate_source":false}],"load_policy":{"run_mode":"once","initial_load_rule":"append","conflict_policy":"fail"},"compute":{"task_compute_resource_id":"default","query_compute_resource_id":"default","priority":"normal"},"consistency_contract":{"contract_kind":"worker_proved_persistent_watermark","proof_kind":"db_metadata","proof_hash":"$PROOF_HASH","capability_profile_hash":"$CAPABILITY_PROFILE_HASH"}}}
EOF

周期任务将 load_policy.run_mode 设为 periodic，填写 sync_strategy 和 schedule；来源、目标、映射、计算资源和一致性契约仍是完整请求的一部分。

curl -X POST "https://moi.matrixorigin.cn/newmoi/task" -H "X-API-Key: $AI_STUDIO_API_KEY" -H "X-Workspace-ID: $WORKSPACE_ID" -H "Idempotency-Key: $IDEMPOTENCY_KEY" -H "Content-Type: application/json" -d @- <<EOF
{"config_type":3,"structured_load_config":{"version":1,"source":{"connector_id":"$CONNECTOR_ID","source_type":"SOURCE_TYPE_MYSQL","database":"sales","table":"orders"},"target":{"mode":"existing","database_id":"$DATABASE_ID","table_id":"$TARGET_TABLE_ID"},"mapping":[{"source":{"kind":"column","column":"order_id"},"target_column":"order_id","target_type":"BIGINT","nullable":false,"primary_key":true,"allow_duplicate_source":false}],"load_policy":{"run_mode":"periodic","initial_load_rule":"append","sync_strategy":"incremental","conflict_policy":"fail"},"schedule":{"kind":"hourly","interval":6,"timezone":"Asia/Shanghai"},"compute":{"task_compute_resource_id":"default","query_compute_resource_id":"default","priority":"normal"},"consistency_contract":{"contract_kind":"worker_proved_persistent_watermark","proof_kind":"db_metadata","proof_hash":"$PROOF_HASH","capability_profile_hash":"$CAPABILITY_PROFILE_HASH"}}}
EOF

参数

类型

是否必填

说明

config_type

integer

是

固定为 3，表示数据库结构化载入。

name

string

否

任务名称。

structured_load_config

object

是

结构化载入配置。

structured_load_config.version

integer

是

固定为 1。

structured_load_config.source

object

是

来源表。

structured_load_config.source.connector_id

string

是

来源连接器 ID。

structured_load_config.source.source_type

string

是

来源类型。

structured_load_config.source.database

string

是

来源数据库。

structured_load_config.source.table

string

是

来源表名称。

structured_load_config.target

object

是

已有目标表。

structured_load_config.target.mode

string

是

固定为 existing。

structured_load_config.target.database_id

string

是

目标数据库 ID。

structured_load_config.target.table_id

string

是

已有目标表 ID。

structured_load_config.mapping

array of object

是

来源字段到目标列的映射。

structured_load_config.mapping.source

object

是

来源列。

structured_load_config.mapping.source.kind

string

是

来源字段表示方式。

structured_load_config.mapping.source.column

string

是

来源列名。

structured_load_config.mapping.target_column

string

是

目标列名。

structured_load_config.mapping.target_type

string

是

目标列类型。

structured_load_config.mapping.nullable

boolean

是

目标列是否可为空。

structured_load_config.mapping.primary_key

boolean

是

目标列是否为主键。

structured_load_config.mapping.allow_duplicate_source

boolean

是

是否允许复用来源列。

structured_load_config.load_policy

object

是

一次性导入策略。

structured_load_config.load_policy.run_mode

string

是

固定为 once。

structured_load_config.load_policy.initial_load_rule

string

是

首次载入写入规则。

structured_load_config.load_policy.conflict_policy

string

是

冲突处理规则。

structured_load_config.load_policy.max_rows_per_batch

integer

否

每批最大行数。

structured_load_config.compute

object

是

计算资源设置。

structured_load_config.compute.task_compute_resource_id

string

是

任务计算资源。

structured_load_config.compute.query_compute_resource_id

string

是

查询计算资源。

structured_load_config.compute.priority

string

是

任务优先级。

structured_load_config.consistency_contract

object

是

一致性契约。

structured_load_config.consistency_contract.contract_kind

string

是

一致性契约类型。

structured_load_config.consistency_contract.proof_kind

string

是

证明类型。

structured_load_config.consistency_contract.proof_hash

string

是

字段映射生成结果中的 proof hash。

structured_load_config.consistency_contract.capability_profile_hash

string

是

字段映射生成结果中的 capability profile hash。

参数

类型

是否必填

说明

config_type

integer

是

固定为 3。

structured_load_config

object

是

结构化载入配置。

structured_load_config.version

integer

是

固定为 1。

structured_load_config.source.connector_id

string

是

来源连接器 ID。

structured_load_config.source.source_type

string

是

来源类型。

structured_load_config.source.database

string

是

来源数据库。

structured_load_config.source.table

string

是

来源表。

structured_load_config.target.mode

string

是

固定为 new。

structured_load_config.target.database_id

string

是

新表所在数据库 ID。

structured_load_config.target.table_name

string

是

新表名称。

structured_load_config.target.create_table.name

string

是

新表名称。

structured_load_config.target.create_table.columns

array of object

是

新表列定义。

structured_load_config.target.create_table.columns.name

string

是

列名。

structured_load_config.target.create_table.columns.data_type

string

是

列类型。

structured_load_config.target.create_table.columns.primary_key

boolean

是

是否为主键。

structured_load_config.target.create_table.columns.nullable

boolean

是

是否可为空。

structured_load_config.mapping

array of object

是

来源字段到目标列的映射。

structured_load_config.mapping.source.kind

string

是

来源字段表示方式。

structured_load_config.mapping.source.column

string

是

来源列名。

structured_load_config.mapping.target_column

string

是

目标列名。

structured_load_config.mapping.target_type

string

是

目标列类型。

structured_load_config.mapping.nullable

boolean

是

目标列是否可为空。

structured_load_config.mapping.primary_key

boolean

是

目标列是否为主键。

structured_load_config.mapping.allow_duplicate_source

boolean

是

是否允许复用来源列。

structured_load_config.load_policy.run_mode

string

是

固定为 once。

structured_load_config.load_policy.initial_load_rule

string

是

首次载入规则。

structured_load_config.load_policy.conflict_policy

string

是

冲突规则。

structured_load_config.compute.task_compute_resource_id

string

是

任务计算资源。

structured_load_config.compute.query_compute_resource_id

string

是

查询计算资源。

structured_load_config.compute.priority

string

是

优先级。

structured_load_config.consistency_contract.contract_kind

string

是

一致性契约类型。

structured_load_config.consistency_contract.proof_kind

string

是

证明类型。

structured_load_config.consistency_contract.proof_hash

string

是

proof hash。

structured_load_config.consistency_contract.capability_profile_hash

string

是

capability profile hash。

参数

类型

是否必填

说明

config_type

integer

是

固定为 3。

structured_load_config

object

是

结构化载入配置。

structured_load_config.version

integer

是

固定为 1。

structured_load_config.source.connector_id

string

是

来源连接器 ID。

structured_load_config.source.source_type

string

是

来源类型。

structured_load_config.source.database

string

是

来源数据库。

structured_load_config.source.table

string

是

来源表。

structured_load_config.target.mode

string

是

固定为 existing。

structured_load_config.target.database_id

string

是

目标数据库 ID。

structured_load_config.target.table_id

string

是

目标表 ID。

structured_load_config.mapping

array of object

是

字段映射。

structured_load_config.mapping.source.kind

string

是

来源字段表示方式。

structured_load_config.mapping.source.column

string

是

来源列名。

structured_load_config.mapping.target_column

string

是

目标列名。

structured_load_config.mapping.target_type

string

是

目标列类型。

structured_load_config.mapping.nullable

boolean

是

目标列是否可为空。

structured_load_config.mapping.primary_key

boolean

是

目标列是否为主键。

structured_load_config.mapping.allow_duplicate_source

boolean

是

是否允许复用来源列。

structured_load_config.load_policy.run_mode

string

是

固定为 periodic。

structured_load_config.load_policy.initial_load_rule

string

是

首次载入规则。

structured_load_config.load_policy.sync_strategy

string

是

周期导入策略；可为 incremental 或 full_refresh。

structured_load_config.load_policy.conflict_policy

string

是

冲突规则。

structured_load_config.schedule.kind

string

是

周期类型；示例为 hourly。

structured_load_config.schedule.interval

integer

hourly 时必填

执行间隔。

structured_load_config.schedule.timezone

string

是

IANA 时区。

structured_load_config.compute.task_compute_resource_id

string

是

任务计算资源。

structured_load_config.compute.query_compute_resource_id

string

是

查询计算资源。

structured_load_config.compute.priority

string

是

优先级。

structured_load_config.consistency_contract.contract_kind

string

是

一致性契约类型。

structured_load_config.consistency_contract.proof_kind

string

是

证明类型。

structured_load_config.consistency_contract.proof_hash

string

是

proof hash。

structured_load_config.consistency_contract.capability_profile_hash

string

是

capability profile hash。

成功响应

{"code":"OK","msg":"OK","data":{"task_id":"task_01"}}

字段

类型

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data.task_id

string

新建任务 ID。

错误响应

{"code":"STRUCTURED_LOAD_CONFIG_INVALID","msg":"invalid structured load configuration","data":{"path":"structured_load_config.target"}}

字段

类型

说明

code

string

错误代码。

msg

string

可读错误信息。

data.path

string

配置错误对应的字段路径。

后续操作

使用返回的 data.task_id 查看导入任务详情确认来源、目标表和运行状态。

最后更新于