查看数据库中的表和视图列表

列出一个数据库中的表和视图。根据对象类型选择后续操作。

POST https://api.moi.matrixorigin.cn/v5/meta/db/table

调用前准备

  1. 准备有目标工作区访问权限的个人访问令牌目标工作区 ID

  2. 查看数据库,选择并记录数据库名称(db_name)。

请求体

将示例中的调用者专属值替换为实际值。

curl -X POST "https://api.moi.matrixorigin.cn/v5/meta/db/table" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"name\": \"$DATABASE\"
  }"

参数

类型

是否必填

说明

name

string

要查看的数据库名称。

成功响应

{
  "code": 200,
  "data": {
    "db_name": "sales",
    "tables": {
      "tables": [
        {
          "name": "orders",
          "owner": "",
          "created": "",
          "rows": 0,
          "size": 0
        }
      ],
      "total": 1
    },
    "views": {
      "tables": [],
      "total": 0
    }
  }
}

字段

类型

说明

code

integer

成功时为 200。

data

object

数据库中的表和视图。

下面表格展开响应示例中的 data 对象;每一行是该对象的一个字段。

字段

类型

说明

db_name

string

被查看的数据库名称。

tables

object

表列表及其总数。

views

object

视图列表及其总数。

下面表格展开响应示例中 data 下的 tables 对象;每一行是该对象的一个字段。

字段

类型

说明

tables

array of object 或 null

表列表。没有表时服务可能返回 null;将其视为空列表。

total

integer

表列表中的对象数量。

下面表格展开 tables 对象中的 tables 列表;每一行是列表中一个表对象的字段。

字段

类型

说明

name

string

表名称;用于查看表信息、字段或建表语句。

owner

string

表对象所有者。

created

string

表对象创建时间。

rows

integer

表对象行数。

size

integer

表对象大小。

下面表格展开响应示例中 data 下的 views 对象;每一行是该对象的一个字段。

字段

类型

说明

tables

array of object 或 null

视图列表。没有视图时服务可能返回 null;将其视为空列表。

total

integer

视图列表中的对象数量。

下面表格展开 views 对象中的 tables 列表;每一行是列表中一个视图对象的字段。

字段

类型

说明

name

string

视图名称;用于查看视图的创建语句或删除视图。

owner

string

视图对象所有者。

created

string

视图对象创建时间。

rows

integer

视图对象行数。

size

integer

视图对象大小。

表名称可用于查看表信息查看表字段列表查看表或视图的创建语句删除表。视图名称可用于查看表或视图的创建语句删除视图

错误响应

{
  "code": 400,
  "message": "name 不能为空"
}

字段

类型

说明

code

integer 或 string

错误代码或状态码。

message

string

错误信息。

后续操作

根据对象类型继续查看表信息查看表或视图的创建语句

最后更新于