# 清空表

删除表中的全部数据，但保留表定义。此操作不可逆，请确认目标表。

```text
POST https://moi.matrixorigin.cn/newmoi/catalog/table/truncate
```

## 调用前准备

先[查询数据库中的对象](list-database-objects.md)取得目标表 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和表 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$TABLE_ID`：要清空的表 ID。

此操作不可逆，请确认目标表。

## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `id` | integer | 是 | 表 ID。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/table/truncate" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$TABLE_ID"'
  }'
```

## 成功响应

成功时返回 `200`，`data` 为 `null`。表定义会保留，表中数据会被删除。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": null
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data` | null | 清空成功时固定为 `null`。 |

## 错误响应

```json
{
  "code": "ErrReadonlySystemDatabase",
  "msg": "数据库不可写",
  "data": null
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - `id` 缺失或请求格式无效。
  - 传入有效的表 ID。
* - `403`
  - `ErrForbidden`
  - 当前身份没有表写入权限。
  - 使用有写入权限的凭据，或联系管理员授权。
* - `409`
  - `ErrReadonlySystemDatabase`
  - 表位于只读系统数据库。
  - 选择可写数据库中的表。
* - `500`
  - `ErrServer`
  - 服务无法清空表数据。
  - 记录请求时间和错误信息后重试；持续失败时联系支持人员。
```

## 后续操作

完成后[查询 Catalog 详情](get-catalog.md)确认结果。