管理 CollectionView 别名

最近更新时间:2024-07-03 15:43:41

我的收藏

功能介绍

别名可以是一个简短的字符串,方便标识和访问对应的集合。一个 CollectionView 可以设置一个或者多个别名。
SetAlias() 接口用于为 CollectionView 指定别名。
DeleteAlias() 接口用于删除数据库指定的集合视图的别名。
说明:
通过集合的别名做业务迁移时,仅需通过 setAlias() 接口将同一别名指向新的集合,别名与集合的映射关系将自动更新为新集合,可直接通过别名访问新集合。

为 CollectionView 创建别名

var (
ctx = context.Background()
aiDatabase = "go-sdk-test-ai-db"
collectionViewName = "go-sdk-test-ai-coll"
aliasName = "go-sdk-test-alias"
)

db := client.AIDatabase(aiDatabase)
colRes, _:= db.SetAlias(ctx, collectionViewName, aliasName)
log.Printf("Set a CollectionView alias: %v", colRes)
参数名
是否必选
参数含义
配置方法及要求
collectionViewName
指定需创建别名的 CollectionView 名称。
使用 ListCollectionViews() 获取指定数据库名下的 CollectionView 列表,复制需设置别名的集合视图。
aliasName
设置别名。
别名要求如下:
只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。
长度要求:[1,128]。

删除 CollectionView 别名

var (
ctx = context.Background()
aiDatabase = "go-sdk-test-ai-db"
aliasName = "go-sdk-test-alias"
)
db := client.AIDatabase(aiDatabase)
colRes, _:= db.DeleteAlias(ctx, aliasName)
log.Printf("Delete CollectionView Alias : %v", colRes)

返回信息

Set a CollectionView alias: &{1}
Delete CollectionView Alias : &{1}
参数名
参数含义
AffectedCount
影响的集合视图数量。

接口约束

DB 和 CollectionView 级别的 drop 操作会同时删除库表下的所有别名。
DocumentSet 层级的访问优先访问别名,其余级别仅支持原 CollectionView 名操作。
集合视图的别名可以和集合视图名重复,一个集合视图的多个别名之间不能重复。