# 查询表数据

读取表的抽样数据。未显式指定行数时，服务默认返回 100 行。

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

## 调用前准备

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

下方示例使用：

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

## 请求体

表的定位方式与[查询表信息](get-table.md)一致：使用 `id`，或使用 `name` 加 `database_id`/`database_name`。

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `id` | integer | 条件必填 | 表 ID。 |
| `name` | string | 条件必填 | 表名；未提供 `id` 时必填。 |
| `database_id` | integer | 条件必填 | 非系统数据库 ID；与 `database_name` 互斥。 |
| `database_name` | string | 条件必填 | 系统数据库名称；与 `database_id` 互斥。 |
| `page` | integer | 否 | 页码，默认 `1`。 |
| `page_size` | integer | 否 | 每页行数，默认 `100`。 |
| `preview_lines` | integer | 否 | 预览行数。 |
| `include_total` | boolean | 否 | 是否返回总行数；未传时返回。 |

## 请求示例

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

## 成功响应

成功时返回 `200` 和抽样结果。无读取权限时返回 `403`。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "data": [
      ["1", "100.00"]
    ],
    "columns": [
      {
        "name": "id",
        "type": "INT"
      },
      {
        "name": "amount",
        "type": "DECIMAL"
      }
    ],
    "total_rows": 120,
    "page": 1,
    "page_size": 100
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.data` | array | 行数据；每个内层数组按 `columns` 的顺序排列。 |
| `data.columns` | array | 列信息，每项包含 `name` 和 `type`。 |
| `data.total_rows` | integer | 表总行数；仅在请求 `include_total` 时返回。 |
| `data.page` | integer | 当前页码。 |
| `data.page_size` | integer | 当前页的行数上限。 |

## 错误响应

```json
{
  "code": "ErrParamInvalid",
  "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`
  - 服务无法读取表数据。
  - 记录请求时间和错误信息后重试；持续失败时联系支持人员。
```

## 后续操作

需要修改时[更新数据库](update-database.md)。返回列表时[查询文件产物](list-file-artifacts.md)。