新增表字段
更新时间:2025-04-18
POST
http://{host}/v{version}/table?addField
在指定表中新增一个字段,当前仅支持新增标量、向量字段。
权限说明
鉴权认证机制的详细内容请参见鉴权认证
请求参数
Headers 参数
除公共头域外,无其它特殊头域
URL 参数
version
string
API版本号,当前取1。
必选
host
string
"{实例IP}:{实例Port}"
必选
Query 参数
addField
string
新增表字段操作
可选
Body 参数
database
string
指定库的名称。
必选
table
string
指定表的名称。
必选
schema
object {1}
待新增字段的Schema定义。
必选
显示子属性
隐藏子属性
fields
array
字段定义列表
必选
显示子属性
隐藏子属性
items
object {3}
显示子属性
隐藏子属性
dimension
integer
向量维度,仅对向量字段有效
可选
fieldName
string
字段名称
必选
fieldType
string
字段类型
必选
请求结构
POST /v{version}/table?addField HTTP/1.1
HOST: {Endpoint}
Authorization: {Authorization}
{
"database": "db_name",
"table": "table_name",
"schema": {
"fields": [
{
"fieldName": "scalar1",
"fieldType": "UINT64"
},
{
"fieldName": "scalar2",
"fieldType": "STRING"
},
{
"fieldName": "vector2",
"fieldType": "FLOAT_VECTOR",
"dimension": 768
}
]
}
}
示例代码
请求示例
curl --location 'http://vdb.nXWNyPCOSLci.vdb.bj.baidubce.com/v1/table?addField' \
--header 'Authorization: Bearer account=root&api_key=eC4bLRy2va******************************' \
--header 'Content-Type: application/json' \
--data '{
"database": "db_test",
"table": "table_test",
"schema": {
"fields": [
{
"fieldName": "age",
"fieldType": "UINT64"
},
{
"fieldName": "name",
"fieldType": "STRING"
},
{
"fieldName": "vector2",
"fieldType": "FLOAT_VECTOR",
"dimension": 768
}
]
}
}'
返回响应
Headers 参数
除公共头域外,无其它特殊头域
返回参数
msg
string
返回信息
可选
code
integer
返回码
可选
响应示例
{
"code": 0,
"msg": "Success"
}