# 查看表或视图的创建语句

查看表或视图的创建语句。响应包含对象定义，不包含表中的数据。

```text
POST https://api.moi.matrixorigin.cn/v5/meta/table/ddl
```

## 调用前准备

1. 准备有目标工作区访问权限的[个人访问令牌](../../../../../guides/genesis/api-keys.md#创建和管理个人访问令牌)和[目标工作区 ID](../../../../../guides/ai-studio/resource-center/workspace.md#复制工作区-id)。
2. [查看数据库](list-databases.md#成功响应)，选择数据库名称。
3. [查看数据库中的表和视图列表](list-database-tables.md#成功响应)，选择表或视图名称。

## 请求体

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

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
curl -X POST "https://api.moi.matrixorigin.cn/v5/meta/table/ddl" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"db_name\": \"$DATABASE\",
    \"table_name\": \"$TABLE\"
  }"

```

:::::
:::::{tab-item} 参数说明

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `db_name` | string | 是 | 表或视图所在的数据库名称。 |
| `table_name` | string | 是 | 要读取 DDL 的表或视图名称。 |

:::::
::::::
:::::::

## 成功响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": 200,
  "data": {
    "create_sql": "CREATE TABLE orders (id INT PRIMARY KEY)"
  }
}
```

:::::
:::::{tab-item} 字段说明

::::{tab-set}
:::{tab-item} 通用字段

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| code | integer | 成功时为 200。 |
| data | object | 表或视图的创建语句。 |

:::
:::{tab-item} 创建语句

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| create_sql | string | 表的 CREATE TABLE 语句，或视图的 CREATE VIEW 语句。 |

:::
::::

:::::
::::::
:::::::

此请求还会记录操作审计。审计写入失败不改变本次业务响应，接口不会因此返回不同的查询结果。

## 错误响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": 404,
  "message": "对象不存在"
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer 或 string | 错误代码或状态码。 |
| `message` | string | 错误信息。 |

:::::
::::::
:::::::

## 后续操作

表对象可继续[查看表字段列表](list-table-columns.md#调用前准备)或[查看表信息](get-table-info.md#调用前准备)。