创建表¶
在指定数据库中创建表。
POST https://moi.matrixorigin.cn/newmoi/catalog/table/create
调用前准备¶
先查询数据库列表取得目标数据库 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和数据库 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$DATABASE_ID:要在其下创建表的目标数据库 ID。
系统、保留或订阅数据库不可创建表。
请求体¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
目标数据库 ID。 |
|
string |
是 |
表名,必须是有效标识符。 |
|
array |
是 |
列定义。每项至少包含列名和类型。 |
|
string |
否 |
表注释。 |
|
string |
否 |
要导入的数据文件 URL;为空时只创建表。 |
|
array |
否 |
导入数据时各列的加载选项。 |
请求示例¶
curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/table/create" \
-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>",
"columns": [
{
"name": "id",
"type": "INT",
"is_pk": true
},
{
"name": "amount",
"type": "DECIMAL"
}
]
}'
成功响应¶
成功时返回 200 和新表 ID。系统、保留或订阅数据库不可创建表。
{
"code": "OK",
"msg": "OK",
"data": {
"id": 1001
}
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
integer |
新建表的 ID。 |
错误响应¶
{
"code": "ErrReadonlySystemDatabase",
"msg": "数据库不可写",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
缺少 |
完整提供表定义后重试。 |
|
|
当前身份没有在目标数据库创建表的权限。 |
使用有写入权限的凭据,或联系管理员授权。 |
|
|
目标数据库不可写。 |
选择可写数据库。 |
|
|
服务无法创建表或导入数据。 |
记录请求时间和错误信息后重试;持续失败时联系支持人员。 |
后续操作¶
使用 data.id 查询表信息。