设置别名

最近更新时间:2024-09-29 15:47:41

我的收藏

接口定义

setAlias() 接口用于为 Collection 设置别名。
setAIAlias() 接口用于为 CollectionView 设置别名。
说明:
别名可以是一个简短的字符串,方便标识和访问对应的集合。通常,别名会替换 Collection 名称用于业务切换等场景。一个Collection 或 CollectionView 可以设置一个或者多个别名。
setAlias()
setAIAlias()
public AffectRes setAlias(String collectionName,String aliasName)
public AffectRes setAIAlias(String collectionViewName, String aliasName)

使用示例

说明:
通过集合的别名做业务迁移时,将同一别名指向新的集合,别名与集合的映射关系将自动更新为新集合,可直接通过别名访问新集合。
DB 和 Collection 级别(包含 AI 类 数据库的CollectionView)的 drop 操作会同时删除库表下的所有别名。
Document 与 DocumentSet 层级的访问优先访问别名,其余级别仅支持原 Collection 或 CollectionView 名操作。
集合或集合视图的别名可以和名称重复,一个集合或集合视图的多个别名之间不能重复。
创建 Collection 别名
创建 CollectionView 别名
// link database
Database db = client.database("db-test");
// set alias
AffectRes affectRes1 = db.setAlias("book-emb", "book-emb-alias");
System.out.println("\\tres: " + affectRes1);
参数
是否必选
参数含义
配置方法及要求
collectionName
指定需创建别名的 Collection 名。
使用 listCollections() 获取指定数据库名下的 Collection 列表,复制需创建别名的集合名。
aliasName
设置 Collection 别名。
Collection 别名要求如下:
只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。
长度要求:[1,128]。
// link database
AIDatabase db = client.aiDatabase("db-test-ai");
// set alias
AffectRes affectRes1 = db.setAIAlias("coll-ai-files", "alias-sdk-test");
System.out.println("\\tres: " + affectRes1);
参数
是否必选
参数含义
配置方法及要求
collectionViewName
指定需创建别名的 CollectionView 名。
使用 listCollectionView() 获取指定数据库名下的 CollectionView 列表,复制需创建别名的集合名。
aliasName
设置别名。
别名要求如下:
只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。
长度要求:[1,128]。

出参描述

输出信息,如下所示。
res: AffectRes{affectedCount=1, code=0, msg='operation success'}
参数名
参数含义
affectedCount
影响行数,即为创建别名的集合数量。