功能介绍
set_alias() 接口用于为 Collection 或 CollectionView 设置别名。别名可以是一个简短的字符串,方便标识和访问对应的集合。通常,别名会替换 Collection 或 CollectionView 的名称用于业务切换等场景。
def set_alias( collection_name: str, collection_alias: str ) -> Dict[str, Any]
def set_alias( collection_view_name: str, alias: str ) -> Dict[str, Any]
使用实例
说明:
通过集合的别名做业务迁移时,仅需通过 set_alias() 接口将同一别名指向新的集合,别名与集合的映射关系将自动更新为新集合,可直接通过别名访问新集合。
DB 和 Collection 级别(包含 AI 类数据库的 CollectionView)的 drop 操作会同时删除库表下的所有别名。
Document 与 DocumentSet 层级的访问优先访问别名,其余级别仅支持原 Collection 或 CollectionView 名操作。
集合或集合视图的别名可以和名称重复,一个集合或集合视图的多个别名之间不能重复。
# Specify the database namedb = client.database('db-test')# set aliasres = db.set_alias(collection_name='book-emb', collection_alias='alias-book-emb')print(res)
参数 | 是否必选 | 参数含义 | 配置方法及要求 |
collection_name | 是 | 指定需创建别名的 Collection 名。 | |
collection_alias | 否 | 设置 Collection 别名。 | Collection 别名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
# Specify the database namedb = client.database('db-test-ai')# set aliasres = db.set_alias(collection_view_name='coll-ai-files', alias='alias-sdk-test')print(res)
参数 | 是否必选 | 参数含义 | 配置方法及要求 |
collection_view_name | 是 | 指定需创建别名的 CollectionView 名。 | |
alias | 否 | 设置 CollectionView 别名。 | CollectionView 别名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
出参描述
{'affectedCount': 1}
参数名 | 参数含义 |
affectedCount | 影响行数,即为创建别名的集合数量。 |