org.dromara.milvus.plus.service

接口 ICMService

所有已知实现类:

AbstractMilvusClientBuilder, MilvusClientBuild

public interface ICMService

方法概要

限定符和类型	方法和说明
default void	addField(String collectionName, io.milvus.v2.service.collection.request.AddFieldReq... addFieldReq) 添加字段到集合
default void	alterAlias(MilvusEntity milvusEntity) alter aliases
default void	createAlias(Class<?> milvusClass)
default void	createAlias(MilvusEntity milvusEntity) create aliases
default void	createCollection(Class<?> milvusClass)
default void	createCollection(MilvusEntity milvusEntity) 创建集合
default void	createIndex(String collectionName, List<io.milvus.v2.common.IndexParam> indexParams) 为集合创建索引
default void	createIndex(String collectionName, String fieldName, io.milvus.v2.common.IndexParam.MetricType metricType, io.milvus.v2.common.IndexParam.IndexType indexType) 为集合中的特定字段创建索引
default void	createPartition(String collectionName, String partitionName) 在指定集合中创建分区
default io.milvus.v2.service.collection.response.DescribeCollectionResp	describeCollection(String collectionName) 获取集合的详细信息
default io.milvus.v2.service.index.response.DescribeIndexResp	describeIndex(String collectionName, FieldFunction fieldName)
default io.milvus.v2.service.index.response.DescribeIndexResp	describeIndex(String collectionName, String fieldName) 获取指定集合中指定字段的索引信息
default void	dropAlias(MilvusEntity milvusEntity) drop aliases
default void	dropCollection(String collectionName) 删除集合
default void	dropIndex(String collectionName, String fieldName) 从指定集合中的指定字段删除索引
default void	dropPartition(String collectionName, String partitionName) 从当前集合中删除指定的分区
io.milvus.v2.client.MilvusClientV2	getClient()
default io.milvus.v2.service.collection.response.GetCollectionStatsResp	getCollectionStats(String collectionName) 获取集合的统计信息
default io.milvus.v2.service.collection.request.CreateCollectionReq.FieldSchema	getField(FieldFunction collectionName, FieldFunction fieldName) 根据字段功能对象获取集合中的特定字段
default io.milvus.v2.service.collection.request.CreateCollectionReq.FieldSchema	getField(String collectionName, String fieldName) 获取集合中的特定字段
default Boolean	getLoadState(String collectionName, String partitionName) 获取指定集合或分区的加载状态
default boolean	hasCollection(String collectionName) 检查集合是否存在
default Boolean	hasPartition(String collectionName, String partitionName) 检查指定的分区是否存在于指定的集合中
default Boolean	isCollectionLoaded(String collectionName) 获取指定集合的加载状态，忽略分区
default io.milvus.v2.service.utility.response.ListAliasResp	listAliases(MilvusEntity milvusEntity) list aliases
default List<String>	listPartitions(String collectionName) 列出指定集合中的所有分区
default void	loadCollection(String collectionName) 加载指定集合的数据到内存中，使用默认参数
default void	loadCollection(String collectionName, Integer numReplicas, Boolean async, Long timeout) 加载指定集合的数据到内存中
default void	loadPartition(String collectionName, String partitionName) 便利方法，加载指定集合中的单个分区到内存
default void	loadPartitions(String collectionName, List<String> partitionNames) 加载指定集合中的指定分区到内存
default void	releaseCollection(String collectionName) 从内存中释放指定集合的数据，使用默认参数
default void	releaseCollection(String collectionName, Boolean async, Long timeout) 从内存中释放指定集合的数据
default void	releasePartition(String collectionName, String partitionName) 便利方法，从内存中释放指定集合中的单个分区
default void	releasePartitions(String collectionName, List<String> partitionNames) 从内存中释放指定集合中的指定分区
default void	renameCollection(String oldCollectionName, String newCollectionName) 重命名集合

方法详细资料

getClient

io.milvus.v2.client.MilvusClientV2 getClient()

createCollection

default void createCollection(Class<?> milvusClass)

createCollection

default void createCollection(MilvusEntity milvusEntity)

创建集合

参数:

milvusEntity -

addField

default void addField(String collectionName,
                      io.milvus.v2.service.collection.request.AddFieldReq... addFieldReq)

添加字段到集合

参数:

collectionName - 集合名称

addFieldReq - 字段请求参数

getField

default io.milvus.v2.service.collection.request.CreateCollectionReq.FieldSchema getField(String collectionName,
                                                                                         String fieldName)

获取集合中的特定字段

参数:

collectionName - 集合名称

fieldName - 字段名称

返回:

字段架构信息

getField

default io.milvus.v2.service.collection.request.CreateCollectionReq.FieldSchema getField(FieldFunction collectionName,
                                                                                         FieldFunction fieldName)

根据字段功能对象获取集合中的特定字段

参数:

collectionName - 字段功能对象，代表集合名称

fieldName - 字段功能对象，代表字段名称

返回:

字段架构信息

describeCollection

default io.milvus.v2.service.collection.response.DescribeCollectionResp describeCollection(String collectionName)
                                                                                    throws io.milvus.exception.MilvusException

获取集合的详细信息

参数:

collectionName - 集合名称

返回:

集合详细信息响应对象

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

dropCollection

default void dropCollection(String collectionName)
                     throws io.milvus.exception.MilvusException

删除集合

参数:

collectionName - 要删除的集合名称

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

hasCollection

default boolean hasCollection(String collectionName)
                       throws io.milvus.exception.MilvusException

检查集合是否存在

参数:

collectionName - 集合名称

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

getCollectionStats

default io.milvus.v2.service.collection.response.GetCollectionStatsResp getCollectionStats(String collectionName)
                                                                                    throws io.milvus.exception.MilvusException

获取集合的统计信息

参数:

collectionName - 集合名称

返回:

集合统计信息响应对象

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

renameCollection

default void renameCollection(String oldCollectionName,
                              String newCollectionName)
                       throws io.milvus.exception.MilvusException

重命名集合

参数:

oldCollectionName - 原始集合名称

newCollectionName - 新集合名称

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误，例如集合不存在或新名称与旧名称相同

createIndex

default void createIndex(String collectionName,
                         List<io.milvus.v2.common.IndexParam> indexParams)
                  throws io.milvus.exception.MilvusException

为集合创建索引

参数:

collectionName - 集合名称

indexParams - 索引参数列表，包含要创建的索引的详细信息

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

createIndex

default void createIndex(String collectionName,
                         String fieldName,
                         io.milvus.v2.common.IndexParam.MetricType metricType,
                         io.milvus.v2.common.IndexParam.IndexType indexType)
                  throws io.milvus.exception.MilvusException

为集合中的特定字段创建索引

参数:

collectionName - 集合名称

fieldName - 字段名称

metricType - 度量类型，例如 L2 或 IP

indexType - 索引类型，例如 AUTOINDEX

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

describeIndex

default io.milvus.v2.service.index.response.DescribeIndexResp describeIndex(String collectionName,
                                                                            String fieldName)
                                                                     throws io.milvus.exception.MilvusException

获取指定集合中指定字段的索引信息

参数:

collectionName - 集合名称

fieldName - 字段名称

返回:

索引信息响应对象，包含索引的详细信息

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误，例如集合或字段不存在

describeIndex

default io.milvus.v2.service.index.response.DescribeIndexResp describeIndex(String collectionName,
                                                                            FieldFunction fieldName)
                                                                     throws io.milvus.exception.MilvusException

抛出:

io.milvus.exception.MilvusException

dropIndex

default void dropIndex(String collectionName,
                       String fieldName)
                throws io.milvus.exception.MilvusException

从指定集合中的指定字段删除索引

参数:

collectionName - 集合名称

fieldName - 字段名称，索引将从该字段删除

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误，例如集合或字段不存在

getLoadState

default Boolean getLoadState(String collectionName,
                             String partitionName)
                      throws io.milvus.exception.MilvusException

获取指定集合或分区的加载状态

参数:

collectionName - 集合名称

partitionName - 分区名称，如果为空，则检查整个集合的加载状态

返回:

布尔值，指示指定集合或分区是否已加载

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

isCollectionLoaded

default Boolean isCollectionLoaded(String collectionName)
                            throws io.milvus.exception.MilvusException

获取指定集合的加载状态，忽略分区

参数:

collectionName - 集合名称

返回:

布尔值，指示指定集合是否已加载

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

loadCollection

default void loadCollection(String collectionName,
                            Integer numReplicas,
                            Boolean async,
                            Long timeout)
                     throws io.milvus.exception.MilvusException

加载指定集合的数据到内存中

参数:

collectionName - 要加载的集合名称

numReplicas - 创建的副本数量，默认为1

async - 是否异步执行，默认为true，表示操作可能在后台运行

timeout - 操作的超时时间，默认为60000毫秒（1分钟）

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

loadCollection

default void loadCollection(String collectionName)
                     throws io.milvus.exception.MilvusException

加载指定集合的数据到内存中，使用默认参数

参数:

collectionName - 要加载的集合名称

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

releaseCollection

default void releaseCollection(String collectionName,
                               Boolean async,
                               Long timeout)
                        throws io.milvus.exception.MilvusException

从内存中释放指定集合的数据

参数:

collectionName - 要释放的集合名称

async - 是否异步执行，默认为true，表示操作可能在后台运行

timeout - 操作的超时时间，默认为60000毫秒（1分钟）

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

releaseCollection

default void releaseCollection(String collectionName)
                        throws io.milvus.exception.MilvusException

从内存中释放指定集合的数据，使用默认参数

参数:

collectionName - 要释放的集合名称

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

createPartition

default void createPartition(String collectionName,
                             String partitionName)
                      throws io.milvus.exception.MilvusException

在指定集合中创建分区

参数:

collectionName - 集合名称

partitionName - 要创建的分区名称

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误，例如集合不存在或分区名称已存在

dropPartition

default void dropPartition(String collectionName,
                           String partitionName)
                    throws io.milvus.exception.MilvusException

从当前集合中删除指定的分区

参数:

collectionName - 集合名称

partitionName - 要删除的分区名称

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误，例如集合或分区不存在

hasPartition

default Boolean hasPartition(String collectionName,
                             String partitionName)
                      throws io.milvus.exception.MilvusException

检查指定的分区是否存在于指定的集合中

参数:

collectionName - 集合名称

partitionName - 分区名称

返回:

布尔值，如果分区存在返回true，否则返回false

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

listPartitions

default List<String> listPartitions(String collectionName)
                             throws io.milvus.exception.MilvusException

列出指定集合中的所有分区

参数:

collectionName - 集合名称

返回:

分区名称的列表

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

loadPartitions

default void loadPartitions(String collectionName,
                            List<String> partitionNames)
                     throws io.milvus.exception.MilvusException

加载指定集合中的指定分区到内存

参数:

collectionName - 集合名称

partitionNames - 要加载的分区名称列表

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

loadPartition

default void loadPartition(String collectionName,
                           String partitionName)
                    throws io.milvus.exception.MilvusException

便利方法，加载指定集合中的单个分区到内存

参数:

collectionName - 集合名称

partitionName - 要加载的单个分区名称

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

releasePartitions

default void releasePartitions(String collectionName,
                               List<String> partitionNames)
                        throws io.milvus.exception.MilvusException

从内存中释放指定集合中的指定分区

参数:

collectionName - 集合名称

partitionNames - 要释放的分区名称列表

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

releasePartition

default void releasePartition(String collectionName,
                              String partitionName)
                       throws io.milvus.exception.MilvusException

便利方法，从内存中释放指定集合中的单个分区

参数:

collectionName - 集合名称

partitionName - 要释放的单个分区名称

抛出:

io.milvus.exception.MilvusException - 如果操作过程中发生错误

createAlias

default void createAlias(MilvusEntity milvusEntity)

create aliases

createAlias

default void createAlias(Class<?> milvusClass)

dropAlias

default void dropAlias(MilvusEntity milvusEntity)

drop aliases

alterAlias

default void alterAlias(MilvusEntity milvusEntity)

alter aliases

listAliases

default io.milvus.v2.service.utility.response.ListAliasResp listAliases(MilvusEntity milvusEntity)

list aliases

返回:

List alias names