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

文档中心

立即注册

导航

updateIndex

最近更新时间：2024.04.17 14:21:07首次发布时间：2024.04.17 14:21:07

概述

updateIndex 接口用于更新指定 Index 的描述、cpuQuota、scalarIndex。

请求参数

请求参数是 CreateIndexParam，CreateIndexParam 类包括的参数如下表所示。

参数	类型	是否必选	默认值	参数说明
collectionName	string	是		指定创建索引所属的 Collection 名称。只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空。长度要求：[1, 128]。 Collection 名称不能重复。
indexName	string	是		指定创建的索引 Index 名称。只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空。长度要求：[1, 128]。索引名称不能重复。
cpuQuota	int	否	2	索引检索消耗的 CPU 配额，格式为正整数。与吞吐量有关，和延迟无关，1CPU 核约为 100QPS。 N个分片数量N倍的 CPU 消耗；如果检索消耗的 CPU 超过配额，该索引会被限流。取值范围：[2, 10240]。
description	string	否	”“	索引的自定义描述。
scalarIndex	array	否	None	标量字段列表。 scalarIndex 默认为 None，表示所有字段构建到标量索引。 scalarIndex 为 [] 时，表示无标量索引。 scalarIndex 为非空列表时，表示将列表内字段构建到标量索引。
shard_count	int	否	1	分片数。索引分片是指在大规模数据量场景下，可以把索引数据切分成多个小的索引块，分发到同一个集群不同节点进行管理，每个节点负责存储和处理一部分数据，可以将查询负载分散到不同的节点上，并发的进行处理。当一个节点发生故障时，系统可以自动将其上的分片数据迁移到其他的正常节点上，保证稳定性，以实现数据的水平扩展和高性能的读写操作。取值范围：[1, 256]。默认为1，分片数预估参考：数据预估数据量/3000万。

示例

请求参数

List<String> scalar_index = new ArrayList<>();
        scalar_index.add("like");
        UpdateIndexParam parmas = new UpdateIndexParam().setCollectionName("example")
                                        .setIndexName("example_index")
                                        .setCpuQuoat(3)
                                        .setDescription("java test")
                                        .setScalarIndex(scalar_index)
                                        .build();
        vikingDBService.updateIndex(parmas);

返回值

Java 调用执行上面的任务，无返回。