创建表¶
在指定数据库中创建表。
POST https://moi.matrixorigin.cn/newmoi/catalog/table/create
调用前准备¶
先查询数据库列表取得目标数据库 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和数据库 ID。 系统、保留或订阅数据库不可创建表。
请求体¶
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"
}
]
}'
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
目标数据库 ID。 |
|
string |
是 |
表名,必须是有效标识符。 |
|
array of object |
是 |
列定义。 |
|
string |
否 |
表注释。 |
|
string |
否 |
要导入的数据文件 URL;为空时只创建表。 |
|
array of object |
否 |
导入数据时各列的加载选项。 |
下面表格展开请求中 columns 数组的每一项;每一行是该数组项的一个字段。
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
string |
是 |
列名称。 |
|
string |
是 |
列的数据类型。 |
|
boolean |
否 |
是否为主键列。 |
|
string |
否 |
列注释。 |
|
array of integer |
否 |
精度;最多包含精度和小数位数。 |
|
string |
否 |
列的默认值。 |
下面表格展开请求中 column_load_options 数组的每一项;每一行是该数组项的一个字段。
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
string |
否 |
要配置的列名称。 |
|
string |
否 |
数据来源: |
成功响应¶
成功时返回 200 和新表 ID。系统、保留或订阅数据库不可创建表。
{
"code": "OK",
"msg": "OK",
"data": {
"id": 1001
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
下面表格展开响应示例中 data 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
新建表的 ID。 |
错误响应¶
{
"code": "ErrReadonlySystemDatabase",
"msg": "数据库不可写",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
错误信息。 |
|
null |
错误响应中的附加数据;本示例为 |
后续操作¶
使用 data.id 查询表信息。