检查表是否存在

检查指定数据库中是否存在给定表名。

POST https://moi.matrixorigin.cn/newmoi/catalog/table/exist

调用前准备

查询数据库列表取得目标数据库 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和数据库 ID。

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $DATABASE_ID:要检查的数据库 ID。

请求体

参数

类型

是否必填

说明

database_id

integer

数据库 ID。

name

string

要检查的表名。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/table/exist" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "database_id": '"$DATABASE_ID"',
    "name": "<TABLE_NAME>"
  }'

成功响应

成功时返回 200 和存在性检查结果。该结果只表示检查已完成,不会创建或修改表。

{
  "code": "OK",
  "msg": "OK",
  "data": true
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

boolean

true 表示表存在,false 表示表不存在。

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

请求体格式、数据库 ID 或表名无效。

检查 database_idname

403

ErrForbidden

当前身份没有对应数据库的读取权限。

检查工作区和数据库授权。

500

ErrServer

服务无法检查表是否存在。

记录请求时间和错误信息后重试;持续失败时联系支持人员。

后续操作

表存在时查询表信息;不存在时创建表

最后更新于