You need to enable JavaScript to run this app.
导航

get_index

最近更新时间2023.12.27 15:44:56

首次发布时间2023.11.09 18:59:55

概述

get_index 用于查询索引 Index 详情。

请求参数

参数

类型

是否必选

参数说明

collection_name

string

指定要查询索引所属的 Collection 名称。

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

index_name

string

指定要查询的 Index 名称。

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

示例

请求参数

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

索引状态。取值如下:

  • init:初始化,可能在构建或加载中。
  • ready:已上线,可以正式提供服务。

shard_count

int

分片数。

create_time

string

索引创建时间。

update_time

string

索引更新时间。

update_person

string

索引更新人。

index_cost

map

  • cpu_core:索引占用 CPU 核数。
  • mem_gb:索引占内存大小。