检查表是否存在

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

POST https://api.moi.matrixorigin.cn/v5/catalog/table/exist

调用前准备

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

请求体

curl -X POST "https://api.moi.matrixorigin.cn/v5/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>"
  }'

字段

类型

必填

说明

database_id

integer

是

数据库 ID。

name

string

是

要检查的表名。

成功响应

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

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

字段

类型

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data

object

存在性检查结果。

data.data

boolean

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

错误响应

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

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

错误响应中的附加数据;本示例为 null。

后续操作

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

最后更新于