io.milvus.client

Class MilvusMultiServiceClient

java.lang.Object

io.milvus.client.MilvusMultiServiceClient

All Implemented Interfaces:

MilvusClient

public class MilvusMultiServiceClient
extends java.lang.Object
implements MilvusClient

Constructor Summary

Constructors

Constructor and Description
MilvusMultiServiceClient(@NonNull MultiConnectParam multiConnectParam) Sets connect param for multi milvus clusters.

Method Summary

Modifier and Type	Method and Description
R<RpcStatus>	alterAlias(AlterAliasParam requestParam) Alters alias from a collection to another.
void	close(long maxWaitSeconds) Disconnects from a Milvus server with configurable timeout.
R<RpcStatus>	createAlias(CreateAliasParam requestParam) Creates an alias for a collection.
R<RpcStatus>	createCollection(CreateCollectionParam requestParam) Creates a collection in Milvus.
R<RpcStatus>	createCredential(CreateCredentialParam requestParam) Create credential using the given user and password.
R<RpcStatus>	createIndex(CreateIndexParam requestParam) Creates an index on a vector field in the specified collection.
R<RpcStatus>	createPartition(CreatePartitionParam requestParam) Creates a partition in the specified collection.
R<io.milvus.grpc.MutationResult>	delete(DeleteParam requestParam) Deletes entity(s) based on primary key(s) filtered by boolean expression.
R<RpcStatus>	deleteCredential(DeleteCredentialParam requestParam) Delete credential corresponding to the user.
R<io.milvus.grpc.DescribeCollectionResponse>	describeCollection(DescribeCollectionParam requestParam) Shows the details of a collection, e.g.
R<io.milvus.grpc.DescribeIndexResponse>	describeIndex(DescribeIndexParam requestParam) Shows the information of the specified index.
R<RpcStatus>	dropAlias(DropAliasParam requestParam) Drops an alias for the specified collection.
R<RpcStatus>	dropCollection(DropCollectionParam requestParam) Drops a collection.
R<RpcStatus>	dropIndex(DropIndexParam requestParam) Drops the index on a vector field in the specified collection.
R<RpcStatus>	dropPartition(DropPartitionParam requestParam) Drops a partition.
R<io.milvus.grpc.FlushResponse>	flush(FlushParam requestParam) Flushes collections.
R<io.milvus.grpc.GetCollectionStatisticsResponse>	getCollectionStatistics(GetCollectionStatisticsParam requestParam) Shows the statistics information of a collection.
R<io.milvus.grpc.GetCompactionStateResponse>	getCompactionState(GetCompactionStateParam requestParam) Gets the compaction state by id.
R<io.milvus.grpc.GetCompactionPlansResponse>	getCompactionStateWithPlans(GetCompactionPlansParam requestParam) Gets compaction state with its plan.
R<io.milvus.grpc.GetFlushStateResponse>	getFlushState(GetFlushStateParam requestParam) Get flush state of specified segments.
R<io.milvus.grpc.GetIndexBuildProgressResponse>	getIndexBuildProgress(GetIndexBuildProgressParam requestParam) Shows the index building progress, such as how many rows are indexed.
R<io.milvus.grpc.GetIndexStateResponse>	getIndexState(GetIndexStateParam requestParam) Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).
R<io.milvus.grpc.GetMetricsResponse>	getMetrics(GetMetricsParam requestParam) Gets the runtime metrics information of Milvus, returns the result in .json format.
R<io.milvus.grpc.GetPartitionStatisticsResponse>	getPartitionStatistics(GetPartitionStatisticsParam requestParam) Shows the statistics information of a partition.
R<io.milvus.grpc.GetPersistentSegmentInfoResponse>	getPersistentSegmentInfo(GetPersistentSegmentInfoParam requestParam) Gets the information of persistent segments from data node, including row count, persistence state(growing or flushed), etc.
R<io.milvus.grpc.GetQuerySegmentInfoResponse>	getQuerySegmentInfo(GetQuerySegmentInfoParam requestParam) Gets the query information of segments in a collection from query node, including row count, memory usage size, index name, etc.
R<io.milvus.grpc.GetReplicasResponse>	getReplicas(GetReplicasParam requestParam) Returns the collection's replica information
R<java.lang.Boolean>	hasCollection(HasCollectionParam requestParam) Checks if a collection exists.
R<java.lang.Boolean>	hasPartition(HasPartitionParam requestParam) Checks if a partition exists in the specified collection.
R<io.milvus.grpc.MutationResult>	insert(InsertParam requestParam) Inserts entities into a specified collection .
com.google.common.util.concurrent.ListenableFuture<R<io.milvus.grpc.MutationResult>>	insertAsync(InsertParam requestParam) Inserts entities into a specified collection asynchronously.
R<io.milvus.grpc.ListCredUsersResponse>	listCredUsers(ListCredUsersParam requestParam) List all user names.
R<RpcStatus>	loadBalance(LoadBalanceParam requestParam) Moves segment from a query node to another to keep the load balanced.
R<RpcStatus>	loadCollection(LoadCollectionParam requestParam) Loads a collection to memory before search or query.
R<RpcStatus>	loadPartitions(LoadPartitionsParam requestParam) Loads a partition into memory.
R<io.milvus.grpc.ManualCompactionResponse>	manualCompact(ManualCompactParam requestParam) Performs a manual compaction.
R<io.milvus.grpc.QueryResults>	query(QueryParam requestParam) Queries entity(s) based on scalar field(s) filtered by boolean expression.
com.google.common.util.concurrent.ListenableFuture<R<io.milvus.grpc.QueryResults>>	queryAsync(QueryParam requestParam) Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.
R<RpcStatus>	releaseCollection(ReleaseCollectionParam requestParam) Releases a collection from memory to reduce memory usage.
R<RpcStatus>	releasePartitions(ReleasePartitionsParam requestParam) Releases a partition from memory.
R<io.milvus.grpc.SearchResults>	search(SearchParam requestParam) Conducts ANN search on a vector field.
com.google.common.util.concurrent.ListenableFuture<R<io.milvus.grpc.SearchResults>>	searchAsync(SearchParam requestParam) Conducts ANN search on a vector field asynchronously.
R<io.milvus.grpc.ShowCollectionsResponse>	showCollections(ShowCollectionsParam requestParam) Lists all collections or gets collection loading status.
R<io.milvus.grpc.ShowPartitionsResponse>	showPartitions(ShowPartitionsParam requestParam) Shows all partitions in the specified collection.
R<RpcStatus>	updateCredential(UpdateCredentialParam requestParam) Update credential using the given user and password.
MilvusClient	withTimeout(long timeout, java.util.concurrent.TimeUnit timeoutUnit) Timeout setting for rpc call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.milvus.client.MilvusClient

close

Constructor Detail

MilvusMultiServiceClient

public MilvusMultiServiceClient(@NonNull
                                @NonNull MultiConnectParam multiConnectParam)

Sets connect param for multi milvus clusters.

Parameters:

multiConnectParam - multi server connect param

Method Detail

withTimeout

public MilvusClient withTimeout(long timeout,
                                java.util.concurrent.TimeUnit timeoutUnit)

Description copied from interface: MilvusClient

Timeout setting for rpc call.

Specified by:

withTimeout in interface MilvusClient

Parameters:

timeout - set time waiting for a rpc call.

timeoutUnit - time unit

close

public void close(long maxWaitSeconds)
           throws java.lang.InterruptedException

Description copied from interface: MilvusClient

Disconnects from a Milvus server with configurable timeout.

Specified by:

close in interface MilvusClient

Parameters:

maxWaitSeconds - timeout unit: second

Throws:

java.lang.InterruptedException

hasCollection

public R<java.lang.Boolean> hasCollection(HasCollectionParam requestParam)

Description copied from interface: MilvusClient

Checks if a collection exists.

Specified by:

hasCollection in interface MilvusClient

Parameters:

requestParam - HasCollectionParam

Returns:

{status:result code, data: boolean, whether if has collection or not}

createCollection

public R<RpcStatus> createCollection(CreateCollectionParam requestParam)

Description copied from interface: MilvusClient

Creates a collection in Milvus.

Specified by:

createCollection in interface MilvusClient

Parameters:

requestParam - CreateCollectionParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

dropCollection

public R<RpcStatus> dropCollection(DropCollectionParam requestParam)

Description copied from interface: MilvusClient

Drops a collection. Note that this method drops all data in the collection.

Specified by:

dropCollection in interface MilvusClient

Parameters:

requestParam - DropCollectionParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

loadCollection

public R<RpcStatus> loadCollection(LoadCollectionParam requestParam)

Description copied from interface: MilvusClient

Loads a collection to memory before search or query.

Specified by:

loadCollection in interface MilvusClient

Parameters:

requestParam - LoadCollectionParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

releaseCollection

public R<RpcStatus> releaseCollection(ReleaseCollectionParam requestParam)

Description copied from interface: MilvusClient

Releases a collection from memory to reduce memory usage. Note that you cannot search while the corresponding collection is released from memory.

Specified by:

releaseCollection in interface MilvusClient

Parameters:

requestParam - ReleaseCollectionParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

describeCollection

public R<io.milvus.grpc.DescribeCollectionResponse> describeCollection(DescribeCollectionParam requestParam)

Description copied from interface: MilvusClient

Shows the details of a collection, e.g. name, schema.

Specified by:

describeCollection in interface MilvusClient

Parameters:

requestParam - DescribeCollectionParam

Returns:

{status:result code, data:DescribeCollectionResponse{schema,collectionID}}

getCollectionStatistics

public R<io.milvus.grpc.GetCollectionStatisticsResponse> getCollectionStatistics(GetCollectionStatisticsParam requestParam)

Description copied from interface: MilvusClient

Shows the statistics information of a collection.

Specified by:

getCollectionStatistics in interface MilvusClient

Parameters:

requestParam - GetCollectionStatisticsParam

Returns:

{status:result code, data: GetCollectionStatisticsResponse{status,stats}}

showCollections

public R<io.milvus.grpc.ShowCollectionsResponse> showCollections(ShowCollectionsParam requestParam)

Description copied from interface: MilvusClient

Lists all collections or gets collection loading status.

Specified by:

showCollections in interface MilvusClient

Parameters:

requestParam - ShowCollectionsParam

Returns:

{status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}

flush

public R<io.milvus.grpc.FlushResponse> flush(FlushParam requestParam)

Description copied from interface: MilvusClient

Flushes collections. Currently we do not support this method on client since compaction is not supported on server.

Specified by:

flush in interface MilvusClient

Parameters:

requestParam - FlushParam

Returns:

{status:result code,data: FlushResponse{flush segment ids}}

createPartition

public R<RpcStatus> createPartition(CreatePartitionParam requestParam)

Description copied from interface: MilvusClient

Creates a partition in the specified collection.

Specified by:

createPartition in interface MilvusClient

Parameters:

requestParam - CreatePartitionParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

dropPartition

public R<RpcStatus> dropPartition(DropPartitionParam requestParam)

Description copied from interface: MilvusClient

Drops a partition. Note that this method drops all data in this partition and the _default partition cannot be dropped.

Specified by:

dropPartition in interface MilvusClient

Parameters:

requestParam - DropPartitionParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

hasPartition

public R<java.lang.Boolean> hasPartition(HasPartitionParam requestParam)

Description copied from interface: MilvusClient

Checks if a partition exists in the specified collection.

Specified by:

hasPartition in interface MilvusClient

Parameters:

requestParam - HasPartitionParam

Returns:

{status:result code, data: boolean, whether if has collection or not}

loadPartitions

public R<RpcStatus> loadPartitions(LoadPartitionsParam requestParam)

Description copied from interface: MilvusClient

Loads a partition into memory.

Specified by:

loadPartitions in interface MilvusClient

Parameters:

requestParam - LoadPartitionsParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

releasePartitions

public R<RpcStatus> releasePartitions(ReleasePartitionsParam requestParam)

Description copied from interface: MilvusClient

Releases a partition from memory.

Specified by:

releasePartitions in interface MilvusClient

Parameters:

requestParam - ReleasePartitionsParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

getPartitionStatistics

public R<io.milvus.grpc.GetPartitionStatisticsResponse> getPartitionStatistics(GetPartitionStatisticsParam requestParam)

Description copied from interface: MilvusClient

Shows the statistics information of a partition.

Specified by:

getPartitionStatistics in interface MilvusClient

Parameters:

requestParam - GetPartitionStatisticsParam

Returns:

{status:result code,data:GetPartitionStatisticsResponse{status,stats}}

showPartitions

public R<io.milvus.grpc.ShowPartitionsResponse> showPartitions(ShowPartitionsParam requestParam)

Description copied from interface: MilvusClient

Shows all partitions in the specified collection.

Specified by:

showPartitions in interface MilvusClient

Parameters:

requestParam - ShowPartitionsParam

Returns:

{status:result code, data:ShowPartitionsResponse{partition_names,partitionIDs,created_timestamps,created_utc_timestamps}}

createAlias

public R<RpcStatus> createAlias(CreateAliasParam requestParam)

Description copied from interface: MilvusClient

Creates an alias for a collection. Alias can be used in search or query to replace the collection name

Specified by:

createAlias in interface MilvusClient

Parameters:

requestParam - CreateAliasParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

dropAlias

public R<RpcStatus> dropAlias(DropAliasParam requestParam)

Description copied from interface: MilvusClient

Drops an alias for the specified collection.

Specified by:

dropAlias in interface MilvusClient

Parameters:

requestParam - DropAliasParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

alterAlias

public R<RpcStatus> alterAlias(AlterAliasParam requestParam)

Description copied from interface: MilvusClient

Alters alias from a collection to another.

Specified by:

alterAlias in interface MilvusClient

Parameters:

requestParam - AlterAliasParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

createIndex

public R<RpcStatus> createIndex(CreateIndexParam requestParam)

Description copied from interface: MilvusClient

Creates an index on a vector field in the specified collection. Note that index building is an async progress.

Specified by:

createIndex in interface MilvusClient

Parameters:

requestParam - CreateIndexParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

dropIndex

public R<RpcStatus> dropIndex(DropIndexParam requestParam)

Description copied from interface: MilvusClient

Drops the index on a vector field in the specified collection.

Specified by:

dropIndex in interface MilvusClient

Parameters:

requestParam - DropIndexParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

describeIndex

public R<io.milvus.grpc.DescribeIndexResponse> describeIndex(DescribeIndexParam requestParam)

Description copied from interface: MilvusClient

Shows the information of the specified index. Current release of Milvus only supports showing latest built index.

Specified by:

describeIndex in interface MilvusClient

Parameters:

requestParam - DescribeIndexParam

Returns:

{status:result code, data:DescribeIndexResponse{status,index_descriptions}}

getIndexState

public R<io.milvus.grpc.GetIndexStateResponse> getIndexState(GetIndexStateParam requestParam)

Description copied from interface: MilvusClient

Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).

Specified by:

getIndexState in interface MilvusClient

Parameters:

requestParam - GetIndexStateParam

Returns:

{status:result code, data:GetIndexStateResponse{status,state}}

getIndexBuildProgress

public R<io.milvus.grpc.GetIndexBuildProgressResponse> getIndexBuildProgress(GetIndexBuildProgressParam requestParam)

Description copied from interface: MilvusClient

Shows the index building progress, such as how many rows are indexed.

Specified by:

getIndexBuildProgress in interface MilvusClient

Parameters:

requestParam - GetIndexBuildProgressParam

Returns:

{status:result code, data:GetIndexBuildProgressResponse{status,indexed_rows}}

insert

public R<io.milvus.grpc.MutationResult> insert(InsertParam requestParam)

Description copied from interface: MilvusClient

Inserts entities into a specified collection . Note that you don't need to input primary key field if auto_id is enabled.

Specified by:

insert in interface MilvusClient

Parameters:

requestParam - InsertParam

Returns:

{status:result code, data: MutationResult{insert results}}

insertAsync

public com.google.common.util.concurrent.ListenableFuture<R<io.milvus.grpc.MutationResult>> insertAsync(InsertParam requestParam)

Description copied from interface: MilvusClient

Inserts entities into a specified collection asynchronously. Note that you don't need to input primary key field if auto_id is enabled.

Specified by:

insertAsync in interface MilvusClient

Parameters:

requestParam - InsertParam

Returns:

a ListenableFuture object which holds the object {status:result code, data: MutationResult{insert results}}

delete

public R<io.milvus.grpc.MutationResult> delete(DeleteParam requestParam)

Description copied from interface: MilvusClient

Deletes entity(s) based on primary key(s) filtered by boolean expression. Current release of Milvus only supports expression in the format "pk_field in [1, 2, ...]"

Specified by:

delete in interface MilvusClient

Parameters:

requestParam - DeleteParam

Returns:

{status:result code, data: MutationResult{delete results}}

search

public R<io.milvus.grpc.SearchResults> search(SearchParam requestParam)

Description copied from interface: MilvusClient

Conducts ANN search on a vector field. Use expression to do filtering before search.

Specified by:

search in interface MilvusClient

Parameters:

requestParam - SearchParam

Returns:

{status:result code, data: SearchResults{topK results}}

searchAsync

public com.google.common.util.concurrent.ListenableFuture<R<io.milvus.grpc.SearchResults>> searchAsync(SearchParam requestParam)

Description copied from interface: MilvusClient

Conducts ANN search on a vector field asynchronously. Use expression to do filtering before search.

Specified by:

searchAsync in interface MilvusClient

Parameters:

requestParam - SearchParam

Returns:

a ListenableFuture object which holds the object {status:result code, data: SearchResults{topK results}}

query

public R<io.milvus.grpc.QueryResults> query(QueryParam requestParam)

Description copied from interface: MilvusClient

Queries entity(s) based on scalar field(s) filtered by boolean expression. Note that the order of the returned entities cannot be guaranteed.

Specified by:

query in interface MilvusClient

Parameters:

requestParam - QueryParam

Returns:

{status:result code,data: QueryResults{filter results}}

queryAsync

public com.google.common.util.concurrent.ListenableFuture<R<io.milvus.grpc.QueryResults>> queryAsync(QueryParam requestParam)

Description copied from interface: MilvusClient

Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression. Note that the order of the returned entities cannot be guaranteed.

Specified by:

queryAsync in interface MilvusClient

Parameters:

requestParam - QueryParam

Returns:

{status:result code,data: QueryResults{filter results}}

getMetrics

public R<io.milvus.grpc.GetMetricsResponse> getMetrics(GetMetricsParam requestParam)

Description copied from interface: MilvusClient

Gets the runtime metrics information of Milvus, returns the result in .json format.

Specified by:

getMetrics in interface MilvusClient

Parameters:

requestParam - GetMetricsParam

Returns:

{status:result code, data:GetMetricsResponse{status,metrics}}

getFlushState

public R<io.milvus.grpc.GetFlushStateResponse> getFlushState(GetFlushStateParam requestParam)

Description copied from interface: MilvusClient

Get flush state of specified segments.

Specified by:

getFlushState in interface MilvusClient

Parameters:

requestParam - GetFlushStateParam

Returns:

{status:result code, data:GetMetricsResponse{status,metrics}}

getPersistentSegmentInfo

public R<io.milvus.grpc.GetPersistentSegmentInfoResponse> getPersistentSegmentInfo(GetPersistentSegmentInfoParam requestParam)

Description copied from interface: MilvusClient

Gets the information of persistent segments from data node, including row count, persistence state(growing or flushed), etc.

Specified by:

getPersistentSegmentInfo in interface MilvusClient

Parameters:

requestParam - GetPersistentSegmentInfoParam

Returns:

{status:result code, data:GetPersistentSegmentInfoResponse{status,info}}

getQuerySegmentInfo

public R<io.milvus.grpc.GetQuerySegmentInfoResponse> getQuerySegmentInfo(GetQuerySegmentInfoParam requestParam)

Description copied from interface: MilvusClient

Gets the query information of segments in a collection from query node, including row count, memory usage size, index name, etc.

Specified by:

getQuerySegmentInfo in interface MilvusClient

Parameters:

requestParam - GetQuerySegmentInfoParam

Returns:

{status:result code, data:GetQuerySegmentInfoResponse{status,info}}

getReplicas

public R<io.milvus.grpc.GetReplicasResponse> getReplicas(GetReplicasParam requestParam)

Description copied from interface: MilvusClient

Returns the collection's replica information

Specified by:

getReplicas in interface MilvusClient

Parameters:

requestParam - GetReplicasParam

Returns:

{status:result code, data:GetReplicasResponse{status,info}}

loadBalance

public R<RpcStatus> loadBalance(LoadBalanceParam requestParam)

Description copied from interface: MilvusClient

Moves segment from a query node to another to keep the load balanced.

Specified by:

loadBalance in interface MilvusClient

Parameters:

requestParam - LoadBalanceParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

getCompactionState

public R<io.milvus.grpc.GetCompactionStateResponse> getCompactionState(GetCompactionStateParam requestParam)

Description copied from interface: MilvusClient

Gets the compaction state by id.

Specified by:

getCompactionState in interface MilvusClient

Parameters:

requestParam - GetCompactionStateParam

Returns:

{status:result code, data:GetCompactionStateResponse{status,info}}

manualCompact

public R<io.milvus.grpc.ManualCompactionResponse> manualCompact(ManualCompactParam requestParam)

Description copied from interface: MilvusClient

Performs a manual compaction.

Specified by:

manualCompact in interface MilvusClient

Parameters:

requestParam - ManualCompactParam

Returns:

{status:result code, data:ManualCompactionResponse{status,info}}

getCompactionStateWithPlans

public R<io.milvus.grpc.GetCompactionPlansResponse> getCompactionStateWithPlans(GetCompactionPlansParam requestParam)

Description copied from interface: MilvusClient

Gets compaction state with its plan.

Specified by:

getCompactionStateWithPlans in interface MilvusClient

Parameters:

requestParam - GetCompactionPlansParam

Returns:

{status:result code, data:GetCompactionPlansResponse{status,info}}

createCredential

public R<RpcStatus> createCredential(CreateCredentialParam requestParam)

Description copied from interface: MilvusClient

Create credential using the given user and password.

Specified by:

createCredential in interface MilvusClient

Parameters:

requestParam - CreateCredentialParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

updateCredential

public R<RpcStatus> updateCredential(UpdateCredentialParam requestParam)

Description copied from interface: MilvusClient

Update credential using the given user and password. You must provide the original password to check if the operation is valid. Note: after this operation, client won't change the related header of this connection. So if you update credential for this connection, the connection may be invalid.

Specified by:

updateCredential in interface MilvusClient

Parameters:

requestParam - UpdateCredentialParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

deleteCredential

public R<RpcStatus> deleteCredential(DeleteCredentialParam requestParam)

Description copied from interface: MilvusClient

Delete credential corresponding to the user.

Specified by:

deleteCredential in interface MilvusClient

Parameters:

requestParam - DeleteCredentialParam

Returns:

{status:result code, data:RpcStatus{msg: result message}}

listCredUsers

public R<io.milvus.grpc.ListCredUsersResponse> listCredUsers(ListCredUsersParam requestParam)

Description copied from interface: MilvusClient

List all user names.

Specified by:

listCredUsers in interface MilvusClient

Parameters:

requestParam - ListCredUsersParam

Returns:

{status:result code, data:ListCredUsersResponse{status,info}}