get_index 用于查询索引 Index 详情。
异步调用使用async_get_index接口,参数不变。
参数 | 类型 | 是否必选 | 参数说明 |
---|---|---|---|
collection_name | string | 是 | 指定要查询索引所属的 Collection 名称。
|
index_name | string | 是 | 指定要查询的 Index 名称。
|
res = vikingdb_service.get_index("example", "example_index")
Python 调用执行上面的任务,返回 Index 实例。Index 实例包含的属性如下表所示。
属性 | 类型 | 说明 |
---|---|---|
collection_name | string | 显示索引所属的 Collection 名称。 |
index_name | string | 显示索引 Index 名称。 |
description | string | 显示索引的描述。 |
cpu_quota | int | 显示索引线上检索消耗的 CPU 配额。 |
partition_by | string | partition_by 用于划分子索引 partition,对应字段名称 field_name。根据某个标量字段可以将数据集划分成不同的子数据集,不同的子数据集构建为不同的子索引,实现混合检索时在子索引内检索并减少过滤,从而提升检索性能。 |
vector_index | VectorIndexParams | 向量索引参数。 |
scalar_index | ArrayList | 标量索引字段列表。 |
stat | String | 索引状态。取值如下:
|
shard_count | int | 分片数。 |
create_time | string | 索引创建时间。 |
update_time | string | 索引更新时间。 |
update_person | string | 索引更新人。 |
index_cost | map |
|