文档中心

向量数据库VikingDB

请输入

数据集(Collection)

UpdateVikingdbCollection

概述

UpdateVikingdbCollection用于为指定数据集 Collection 增加字段。
Collection 支持新增字段 fields，已定义字段 fields 不支持修改，仅支持修改数据集描述。

方法定义

Go SDK 通过 vikingdb.New(sess) 创建的客户端实例调用 UpdateVikingdbCollection(input) 方法发起集合更新请求，input 参数类型为 vikingdb.UpdateVikingdbCollectionInput，包含集合名称、描述、项目名称和新增字段定义等配置。

请求参数

请求参数是 UpdateVikingdbCollectionInput，UpdateVikingdbCollectionInput 包含的参数如下表所示。

参数	类型	是否必选	描述
ProjectName	string	否	项目名称，对应 API 字段 `ProjectName`，默认 default。
CollectionName	string	二选一	集合名称，对应 API 字段 `CollectionName`。以字母开头，仅可包含字母、数字、下划线，长度 1-128。可与 `ResourceId` 二选一。
ResourceId	string	二选一	集合资源 ID，对应 API 字段 `ResourceId`。与 `CollectionName` 二选一，推荐同时填写确保准确。
Description	string	否	集合描述，对应 API 字段 `Description`，最长 65535 字节。
Fields	[]FieldForUpdateVikingdbCollectionInput	是	新增字段列表，对应 API 字段 `Fields`。单个集合总字段数上限 128，仅支持追加新字段。

Field 参数结构

参数	类型	是否必选	描述
FieldName	string	是	字段名。必须以英文字母开头，可包含英文字母、数字、下划线和点号，不能以点号结尾，长度不超过 128 Byte。
FieldType	FieldTypeEnum（枚举类型）	是	新增字段类型。支持 string、int64、float32、bool、list[string]、list[int64]、text、date_time、geo_point、list[geo_point]；不支持新增 vector、sparse_vector、tensor、image、video。
DefaultValue	interface{}	否	字段默认值。省略时 int64、float32、string、bool、list<int64>、list<string>、text、date_time、geo_point、list<geo_point> 分别使用 `0`、`0.0`、`"default"`、`false`、`[0]`、`["default"]`、空字符串、`1970-01-01T00:00:00Z`、`"0, 0"`、空列表。

更新接口支持新增 string、int64、float32、bool、list<string>、list<int64>、text、date_time、geo_point、list<geo_point> 字段；不支持新增 vector、sparse_vector、tensor、image、video 字段。

返回参数

参数	类型	示例值	描述
Message	string	success	操作结果描述，对应 API 字段 `Message`。

示例

请求示例

package main

import (
    "fmt"
    "github.com/volcengine/volcengine-go-sdk/service/vikingdb"
    "github.com/volcengine/volcengine-go-sdk/volcengine"
    "github.com/volcengine/volcengine-go-sdk/volcengine/credentials"
    "github.com/volcengine/volcengine-go-sdk/volcengine/session"
    "os"
)

func main() {
    var (
       accessKey      = os.Getenv("VIKINGDB_AK")
       secretKey      = os.Getenv("VIKINGDB_SK")
       region         = "cn-beijing"
       collectionName = "<YOUR_COLLECTION_NAME>"
       description    = "Your Collection Description"
    )
    config := volcengine.NewConfig().
       WithRegion(region).
       WithCredentials(credentials.NewStaticCredentials(accessKey, secretKey, ""))

    sess, err := session.NewSession(config)
    if err != nil {
       panic(err)
    }
    svc := vikingdb.New(sess)

    input := &vikingdb.UpdateVikingdbCollectionInput{
       CollectionName: volcengine.String(collectionName),
       Description:    volcengine.String(description),

       Fields: []*vikingdb.FieldForUpdateVikingdbCollectionInput{
          {
             FieldName: volcengine.String("new_tag"),
             FieldType: volcengine.String("string"),
          },
          {
             FieldName: volcengine.String("extra_score"),
             FieldType: volcengine.String("float32"),
          },
       },
    }

    output, err := svc.UpdateVikingdbCollection(input)
    if err != nil {
       panic(err)
    }
    fmt.Println(output)
}

最近更新时间：2026.09.08 12:03:00

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求示例 #

请求示例