You need to enable JavaScript to run this app.
导航
getIndex
最近更新时间:2024.09.06 10:29:51首次发布时间:2024.04.17 14:21:09

概述

getIndex 用于查询索引 Index 详情。

请求参数

参数

类型

是否必选

参数说明

collectionName

string

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

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

indexName

string

指定要查询的 Index 名称。

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

示例

请求参数

Index index = vikingDBService.getIndex("javaSDKTest", "test_index");

返回值

Java 调用执行上面的任务,返回 Index 实例。Index 实例包含的属性如下表所示。

属性

类型

说明

collectionName

string

显示索引所属的 Collection 名称。

indexName

string

显示索引 Index 名称。

description

string

显示索引的描述。

cpuQuota

int

显示索引线上检索消耗的 CPU 配额。

partitionBy

string

partitionBy 用于划分子索引 partition,对应字段名称 fieldName。根据某个标量字段可以将数据集划分成不同的子数据集,不同的子数据集构建为不同的子索引,实现混合检索时在子索引内检索并减少过滤,从而提升检索性能。

vectorIndex

VectorIndexParams

向量索引参数。

scalarIndex

ArrayList

标量索引字段列表。

stat

String

索引状态。取值如下:

  • INIT:初始化,在构建或加载中。
  • CHANGING:变更中,在变更构建或加载中
  • READY:已上线,可以正式提供服务。

shardCount

int

分片数。

createTime

string

索引创建时间。

updateTime

string

索引更新时间。

updatePerson

string

索引更新人。

indexCost

map

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