读取连接器表字段

database/table必填,可选schema;返回columns六字段,不是structured/v1的schema_snapshot及映射草案对象。

POST https://api.moi.matrixorigin.cn/v5/connectors/db/schema

调用前准备

BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。

准备连接器及同环境身份。示例ID/数据库/结果为固定说明值;当前源码未声明这六条路径已弃用,公开范围和实际部署仍需核对。

请求

curl --request POST \
  "$BASE_URL/connectors/db/schema" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID" \
  --header "Content-Type: application/json" \
  --data '{"connector_id": "source-connector", "database": "source_db", "schema": "analytics", "table": "orders"}'

参数

类型

必填

说明

connector_id

string

是

已保存且当前身份可使用的连接器ID。

database

string

是

所选数据库名。

schema

string

否

需要区分数据库schema时填写。

table

string

是

所选表名。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "columns": [
      {
        "name": "record_id",
        "data_type": "BIGINT",
        "mapped_type": "bigint",
        "is_primary_key": true,
        "is_nullable": false,
        "is_auto_incr": true
      }
    ]
  }
}

字段

类型

说明

code

string

成功为OK,不能只检查HTTP200。

msg

string

响应说明。

data

object

旧式返回对象。

错误与协议选择

比较两套元数据协议后选择调用路径;参数位置和响应形状不互换。错误处理见错误及空结果。

最后更新于