get_collection--向量数据库VikingDB-火山引擎

文档中心

立即注册

导航

get_collection

最近更新时间：2024.09.23 17:53:14首次发布时间：2024.04.17 14:21:08

概述

get_collection 用于查询指定数据集 Collection 的详情信息。
异步调用使用async_get_collection接口，参数不变。

请求参数

参数	类型	是否必选	参数说明
collection_name	string	是	指定查询的 Collection 名称。只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空。长度要求：[1, 128]。 Collection 名称不能重复。

参数

类型

是否必选

参数说明

collection_name

string

是

指定查询的 Collection 名称。

只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空。
长度要求：[1, 128]。
Collection 名称不能重复。

示例

请求参数

res = vikingdb_service.get_collection("example")

# 异步调用
async def get_collection():
    res = await vikingdb_service.async_get_collection("async")
asyncio.run(get_collection())

返回值

Python 调用执行上面的任务，返回 Collection 实例。Collection 实例包含的属性如下表所示

属性	类型	说明
collection_name	string	Collection 名称。
description	string	Collection 的描述。
fields	List	字段列表。
indexes	List	索引列表。
stat	map	统计/状态信息。 data_number：数据量条数。 data_storage：数据占用的存储大小，单位是字节。
create_time	string	数据集创建时间。
update_time	string	数据集更新时间。
update_person	string	数据集更新人。