接口定义
update()
接口用于对通过主键(Document ID)与 Filter 表达式过滤检索 Document ,对 Document 的部分字段进行更新。同时,支持新增字段。Update(ctx context.Context, databaseName string, collectionName string, param UpdateDocumentParams) (result *UpdateDocumentResult, err error)
使用示例
如下示例,更新 id 为 0001、0003,并满足 bookName 条件表达式的 Document 字段 page 的值。
var (ctx = context.Background()database = "go-sdk-test-db"collectionName = "go-sdk-test-coll")result, _ := client.Update(ctx, database, collectionName, tcvectordb.UpdateDocumentParams{QueryIds: []string{"0001", "0003"},QueryFilter: tcvectordb.NewFilter(`bookName="三国演义"`),UpdateFields: map[string]tcvectordb.Field{"page": {Val: 24},},})log.Printf("update affect count: %d", result.AffectedCount)
入参描述
参数名 | 子参数 | 是否必选 | 参数含义 |
databaseName | - | 是 | 指定更新的数据库名。Database 命名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
collectionName | - | 是 | 指定更新数据的集合。Collection 命名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
QueryIds | DocumentIds | 是 | 设置需更新的文档 ID。每个 ID 长度限制为[1,128]。支持批量查询,数组元素范围[1,20]。 |
QueryFilter | Filter | 否 | 使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式。Filter 表达式格式为 <field_name><operator><value>,多个表达式之间支持 and(与)、or(或)、not(非)关系。具体信息,请参见 混合检索。其中: <field_name>:表示要过滤的字段名。 <operator>:表示要使用的运算符。 string :匹配单个字符串值(=)、排除单个字符串值(!=)、匹配任意一个字符串值(in)、排除所有字符串值(not in)。其对应的 Value 必须使用英文双引号括起来。 uint64:大于(>)、大于等于(>=)、等于(=)、小于(<)、小于等于(<=)。例如:expired_time > 1623388524。 array:数组类型,包含数组元素之一(include)、排除数组元素之一(exclude)、全包含数组元素(include all)。例如,name include (\\"Bob\\", \\"Jack\\")。 <value>:表示要匹配的值。 示例: Filter('author="jerry"').And('page>20') |
UpdateFields | vector | 否 | 更新 vector 字段的向量数据。 说明: 如果 Collection 在创建时,未配置 Embedding 参数,或者该实例并未开通 Embedding 功能,则只能配置该参数,输入向量数据,更新数据。 |
| text | 否 | Embedding 模型输入文本的字段名。该字段在创建 Collection 时定义。本示例为 text 。 string:字符型。 float:浮点型数据。 说明: 如果 Collection 在创建时,已配置 Embedding 参数,则只能配置该参数,依据输入的文本信息更新向量数据,并将文本字段与向量数据更新存于数据库。 |
| old_field | 否 | 当前已存在的字段,更新字段对应的数据。 类型:string 字符长度要求:[1,256]。 |
| new_field | 否 | 新增字段,并给新字段赋值。 类型:string。 字符长度要求:[1,256]。 |
出参描述
update affect count: &{AffectedCount:1}
参数名 | 参数含义 |
AffectedCount | 更新的文档数量。如果该参数返回的值为0,说明更新无效。 |