批量查看表信息¶
按表 ID 批量查询表定义和元数据。
POST https://moi.matrixorigin.cn/newmoi/catalog/table/multi_info
调用前准备¶
先查询数据库中的对象取得表 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和表 ID 列表。
请求体¶
curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/table/multi_info" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{
"ids": ['"$TABLE_ID"']
}'
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
integer(整数数组) |
是 |
要查询的表 ID 列表。 |
成功响应¶
成功时返回 200 和每张表的信息。
{
"code": "OK",
"msg": "OK",
"data": {
"tables": [
{
"name": "orders",
"columns": [],
"create_sql": "CREATE TABLE orders (...)"
}
]
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
下面表格展开响应示例中 data 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
object(对象数组) |
查询到的表信息。 |
下面表格展开响应示例中 data.tables 数组的每一项;每一行是该数组项的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
表名称。 |
|
integer |
表行数。 |
|
integer |
表大小。 |
|
array of object |
列定义。 |
|
string |
建表 SQL。 |
|
array of object |
列统计信息。 |
下面表格展开响应示例中 data.tables[].columns 数组的每一项;每一行是该数组项的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
列名称。 |
|
string |
列的数据类型。 |
|
boolean |
是否为主键列;有值时返回。 |
|
string |
列注释;有值时返回。 |
|
array of integer |
精度;有值时返回。 |
|
string |
列默认值;有值时返回。 |
下面表格展开响应示例中 data.tables[].stats 数组的每一项;每一行是该数组项的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
列名称。 |
|
string |
列的数据类型。 |
|
boolean |
是否为主键列;有值时返回。 |
|
string |
列默认值;有值时返回。 |
|
string |
列注释;有值时返回。 |
|
string |
列的最大值。 |
|
string |
列的最小值。 |
错误响应¶
{
"code": "ErrServer",
"msg": "服务器内部错误",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
错误信息。 |
|
null |
错误响应中的附加数据;本示例为 |