Package 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 Description MilvusMultiServiceClient(@NonNull MultiConnectParam multiConnectParam)Sets connect param for multi milvus clusters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description R<RpcStatus>addUserToRole(AddUserToRoleParam requestParam)The user will get permissions that the role are allowed to perform operations.R<RpcStatus>alterAlias(AlterAliasParam requestParam)Alters alias from a collection to another.R<RpcStatus>alterCollection(AlterCollectionParam requestParam)Alter collection.R<io.milvus.grpc.ImportResponse>bulkInsert(BulkInsertParam requestParam)Import data from external files, currently support JSON formatR<io.milvus.grpc.CheckHealthResponse>checkHealth()Check server healthvoidclose(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>createCollection(CreateSimpleCollectionParam requestParam)Creates a collection in Milvus.R<RpcStatus>createCredential(CreateCredentialParam requestParam)Create credential using the given user and password.R<RpcStatus>createDatabase(CreateDatabaseParam requestParam)Creates a database in Milvus.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<RpcStatus>createResourceGroup(CreateResourceGroupParam requestParam)Create a resource group.R<RpcStatus>createRole(CreateRoleParam requestParam)It will success if the role isn't existed, otherwise fail.R<io.milvus.grpc.MutationResult>delete(DeleteParam requestParam)Deletes entity(s) based on primary key(s) filtered by boolean expression.R<DeleteResponse>delete(DeleteIdsParam requestParam)Deletes entity(s) based on the value of primary key.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<io.milvus.grpc.DescribeResourceGroupResponse>describeResourceGroup(DescribeResourceGroupParam requestParam)Describe a resource group.R<RpcStatus>dropAlias(DropAliasParam requestParam)Drops an alias for the specified collection.R<RpcStatus>dropCollection(DropCollectionParam requestParam)Drops a collection.R<RpcStatus>dropDatabase(DropDatabaseParam requestParam)Drops a database.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<RpcStatus>dropResourceGroup(DropResourceGroupParam requestParam)Drop a resource group.R<RpcStatus>dropRole(DropRoleParam requestParam)It will success if the role is existed, otherwise fail.R<io.milvus.grpc.FlushResponse>flush(FlushParam requestParam)Flushes inserted data in buffer into storage.R<io.milvus.grpc.FlushAllResponse>flushAll(boolean syncFlushAll, long syncFlushAllWaitingInterval, long syncFlushAllTimeout)Flush all collections.R<GetResponse>get(GetIdsParam requestParam)Get entity(s) based on the value of primary key.R<io.milvus.grpc.GetImportStateResponse>getBulkInsertState(GetBulkInsertStateParam requestParam)Get state of bulk insert taskR<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.GetFlushAllStateResponse>getFlushAllState(GetFlushAllStateParam requestParam)Get flush state of all segments.R<io.milvus.grpc.GetFlushStateResponse>getFlushState(GetFlushStateParam requestParam)Get flush state of specified collection.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.GetLoadingProgressResponse>getLoadingProgress(GetLoadingProgressParam requestParam)Get collection loading progressR<io.milvus.grpc.GetLoadStateResponse>getLoadState(GetLoadStateParam requestParam)Get collection loading stateR<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 informationR<io.milvus.grpc.GetVersionResponse>getVersion()Get server versionR<RpcStatus>grantRolePrivilege(GrantRolePrivilegeParam requestParam)Grant Role Privilege.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 .R<InsertResponse>insert(InsertRowsParam requestParam)Inserts rows data 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.ListAliasesResponse>listAliases(ListAliasesParam requestParam)List all alias for a collection.R<io.milvus.grpc.ListImportTasksResponse>listBulkInsertTasks(ListBulkInsertTasksParam requestParam)List bulk insert tasksR<ListCollectionsResponse>listCollections(ListCollectionsParam requestParam)Lists all collectionsR<io.milvus.grpc.ListCredUsersResponse>listCredUsers(ListCredUsersParam requestParam)List all user names.R<io.milvus.grpc.ListDatabasesResponse>listDatabases()List databases.R<io.milvus.grpc.ListResourceGroupsResponse>listResourceGroups(ListResourceGroupsParam requestParam)List resource groups.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.R<QueryResponse>query(QuerySimpleParam 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<QueryIterator>queryIterator(QueryIteratorParam requestParam)Get queryIterator 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<RpcStatus>removeUserFromRole(RemoveUserFromRoleParam requestParam)The user will remove permissions that the role are allowed to perform operations.R<RpcStatus>renameCollection(RenameCollectionParam requestParam)rename a collectionR<RpcStatus>revokeRolePrivilege(RevokeRolePrivilegeParam requestParam)Revoke Role Privilege.R<io.milvus.grpc.SearchResults>search(SearchParam requestParam)Conducts ANN search on a vector field.R<SearchResponse>search(SearchSimpleParam 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<SearchIterator>searchIterator(SearchIteratorParam requestParam)Get searchIterator based on a vector field.R<io.milvus.grpc.SelectGrantResponse>selectGrantForRole(SelectGrantForRoleParam requestParam)List a grant info for the role and the specific objectR<io.milvus.grpc.SelectGrantResponse>selectGrantForRoleAndObject(SelectGrantForRoleAndObjectParam requestParam)List a grant info for the roleR<io.milvus.grpc.SelectRoleResponse>selectRole(SelectRoleParam requestParam)Get all users who are added to the role.R<io.milvus.grpc.SelectUserResponse>selectUser(SelectUserParam requestParam)Get all roles the user has.voidsetLogLevel(LogLevel level)Set log level in runtime.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>transferNode(TransferNodeParam requestParam)Transfer a query node from source resource group to target resource_group.R<RpcStatus>transferReplica(TransferReplicaParam requestParam)Transfer a replica from source resource group to target resource_group.R<RpcStatus>updateCredential(UpdateCredentialParam requestParam)Update credential using the given user and password.R<io.milvus.grpc.MutationResult>upsert(UpsertParam requestParam)Insert new entities into a specified collection, replace them if the entities already exist.com.google.common.util.concurrent.ListenableFuture<R<io.milvus.grpc.MutationResult>>upsertAsync(UpsertParam requestParam)Insert new entities into a specified collection asynchronously, replace them if the entities already exist.MilvusClientwithRetry(int retryTimes)Number of retry attempts.MilvusClientwithRetry(RetryParam retryParam)Sets the parameters for retry.MilvusClientwithRetryInterval(long interval, java.util.concurrent.TimeUnit timeUnit)Time interval between retry attempts.MilvusClientwithTimeout(long timeout, java.util.concurrent.TimeUnit timeoutUnit)Timeout setting for rpc call.-
Methods inherited from class java.lang.Object
equals, 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:MilvusClientTimeout setting for rpc call.- Specified by:
withTimeoutin interfaceMilvusClient- Parameters:
timeout- set time waiting for a rpc call.timeoutUnit- time unit
-
withRetry
public MilvusClient withRetry(RetryParam retryParam)
Description copied from interface:MilvusClientSets the parameters for retry.- Specified by:
withRetryin interfaceMilvusClient- Parameters:
retryParam-RetryParam
-
withRetry
public MilvusClient withRetry(int retryTimes)
Description copied from interface:MilvusClientNumber of retry attempts.- Specified by:
withRetryin interfaceMilvusClient- Parameters:
retryTimes- number of retry attempts.
-
withRetryInterval
public MilvusClient withRetryInterval(long interval, java.util.concurrent.TimeUnit timeUnit)
Description copied from interface:MilvusClientTime interval between retry attempts. Default value is 500ms.- Specified by:
withRetryIntervalin interfaceMilvusClient- Parameters:
interval- time interval between retry attempts.timeUnit- time unit
-
close
public void close(long maxWaitSeconds) throws java.lang.InterruptedExceptionDescription copied from interface:MilvusClientDisconnects from a Milvus server with configurable timeout.- Specified by:
closein interfaceMilvusClient- Parameters:
maxWaitSeconds- timeout unit: second- Throws:
java.lang.InterruptedException
-
setLogLevel
public void setLogLevel(LogLevel level)
Description copied from interface:MilvusClientSet log level in runtime.- Specified by:
setLogLevelin interfaceMilvusClient- Parameters:
level-LogLevel
-
hasCollection
public R<java.lang.Boolean> hasCollection(HasCollectionParam requestParam)
Description copied from interface:MilvusClientChecks if a collection exists.- Specified by:
hasCollectionin interfaceMilvusClient- Parameters:
requestParam-HasCollectionParam- Returns:
- {status:result code, data: boolean, whether if has collection or not}
-
createDatabase
public R<RpcStatus> createDatabase(CreateDatabaseParam requestParam)
Description copied from interface:MilvusClientCreates a database in Milvus.- Specified by:
createDatabasein interfaceMilvusClient- Parameters:
requestParam-CreateDatabaseParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
dropDatabase
public R<RpcStatus> dropDatabase(DropDatabaseParam requestParam)
Description copied from interface:MilvusClientDrops a database. Note that this method drops all data in the database.- Specified by:
dropDatabasein interfaceMilvusClient- Parameters:
requestParam-DropDatabaseParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
listDatabases
public R<io.milvus.grpc.ListDatabasesResponse> listDatabases()
Description copied from interface:MilvusClientList databases. Note that this method list all database in the cluster.- Specified by:
listDatabasesin interfaceMilvusClient- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
createCollection
public R<RpcStatus> createCollection(CreateCollectionParam requestParam)
Description copied from interface:MilvusClientCreates a collection in Milvus.- Specified by:
createCollectionin interfaceMilvusClient- Parameters:
requestParam-CreateCollectionParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
dropCollection
public R<RpcStatus> dropCollection(DropCollectionParam requestParam)
Description copied from interface:MilvusClientDrops a collection. Note that this method drops all data in the collection.- Specified by:
dropCollectionin interfaceMilvusClient- Parameters:
requestParam-DropCollectionParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
loadCollection
public R<RpcStatus> loadCollection(LoadCollectionParam requestParam)
Description copied from interface:MilvusClientLoads a collection to memory before search or query.- Specified by:
loadCollectionin interfaceMilvusClient- Parameters:
requestParam-LoadCollectionParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
releaseCollection
public R<RpcStatus> releaseCollection(ReleaseCollectionParam requestParam)
Description copied from interface:MilvusClientReleases a collection from memory to reduce memory usage. Note that you cannot search while the corresponding collection is released from memory.- Specified by:
releaseCollectionin interfaceMilvusClient- Parameters:
requestParam-ReleaseCollectionParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
renameCollection
public R<RpcStatus> renameCollection(RenameCollectionParam requestParam)
Description copied from interface:MilvusClientrename a collection- Specified by:
renameCollectionin interfaceMilvusClient- Parameters:
requestParam-RenameCollectionParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
describeCollection
public R<io.milvus.grpc.DescribeCollectionResponse> describeCollection(DescribeCollectionParam requestParam)
Description copied from interface:MilvusClientShows the details of a collection, e.g. name, schema.- Specified by:
describeCollectionin interfaceMilvusClient- 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:MilvusClientShows the statistics information of a collection.- Specified by:
getCollectionStatisticsin interfaceMilvusClient- 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:MilvusClientLists all collections or gets collection loading status.- Specified by:
showCollectionsin interfaceMilvusClient- Parameters:
requestParam-ShowCollectionsParam- Returns:
- {status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}
-
alterCollection
public R<RpcStatus> alterCollection(AlterCollectionParam requestParam)
Description copied from interface:MilvusClientAlter collection. Currently, only support setting collection TTL with key `collection.ttl.seconds`- Specified by:
alterCollectionin interfaceMilvusClient- Parameters:
requestParam-AlterCollectionParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
flush
public R<io.milvus.grpc.FlushResponse> flush(FlushParam requestParam)
Description copied from interface:MilvusClientFlushes inserted data in buffer into storage.- Specified by:
flushin interfaceMilvusClient- Parameters:
requestParam-FlushParam- Returns:
- {status:result code,data: FlushResponse{flush segment ids}}
-
flushAll
public R<io.milvus.grpc.FlushAllResponse> flushAll(boolean syncFlushAll, long syncFlushAllWaitingInterval, long syncFlushAllTimeout)
Description copied from interface:MilvusClientFlush all collections. All insertions, deletions, and upserts before `flushAll` will be synced.- Specified by:
flushAllin interfaceMilvusClient- Parameters:
syncFlushAll- {flushAll synchronously or asynchronously}syncFlushAllWaitingInterval- {wait intervel when flushAll synchronously}syncFlushAllTimeout- {timeout when flushAll synchronously}- Returns:
- {status:result code,data: FlushAllResponse{flushAllTs}}
-
createPartition
public R<RpcStatus> createPartition(CreatePartitionParam requestParam)
Description copied from interface:MilvusClientCreates a partition in the specified collection.- Specified by:
createPartitionin interfaceMilvusClient- Parameters:
requestParam-CreatePartitionParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
dropPartition
public R<RpcStatus> dropPartition(DropPartitionParam requestParam)
Description copied from interface:MilvusClientDrops a partition. Note that this method drops all data in this partition and the _default partition cannot be dropped.- Specified by:
dropPartitionin interfaceMilvusClient- 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:MilvusClientChecks if a partition exists in the specified collection.- Specified by:
hasPartitionin interfaceMilvusClient- 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:MilvusClientLoads a partition into memory.- Specified by:
loadPartitionsin interfaceMilvusClient- Parameters:
requestParam-LoadPartitionsParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
releasePartitions
public R<RpcStatus> releasePartitions(ReleasePartitionsParam requestParam)
Description copied from interface:MilvusClientReleases a partition from memory.- Specified by:
releasePartitionsin interfaceMilvusClient- 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:MilvusClientShows the statistics information of a partition.- Specified by:
getPartitionStatisticsin interfaceMilvusClient- 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:MilvusClientShows all partitions in the specified collection.- Specified by:
showPartitionsin interfaceMilvusClient- 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:MilvusClientCreates an alias for a collection. Alias can be used in search or query to replace the collection name- Specified by:
createAliasin interfaceMilvusClient- Parameters:
requestParam-CreateAliasParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
dropAlias
public R<RpcStatus> dropAlias(DropAliasParam requestParam)
Description copied from interface:MilvusClientDrops an alias for the specified collection.- Specified by:
dropAliasin interfaceMilvusClient- Parameters:
requestParam-DropAliasParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
alterAlias
public R<RpcStatus> alterAlias(AlterAliasParam requestParam)
Description copied from interface:MilvusClientAlters alias from a collection to another.- Specified by:
alterAliasin interfaceMilvusClient- Parameters:
requestParam-AlterAliasParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
listAliases
public R<io.milvus.grpc.ListAliasesResponse> listAliases(ListAliasesParam requestParam)
Description copied from interface:MilvusClientList all alias for a collection.- Specified by:
listAliasesin interfaceMilvusClient- Parameters:
requestParam-ListAliasesParam- Returns:
- {status:result code, data:ListAliasesResponse{status, aliases}}
-
createIndex
public R<RpcStatus> createIndex(CreateIndexParam requestParam)
Description copied from interface:MilvusClientCreates an index on a vector field in the specified collection. Note that index building is an async progress.- Specified by:
createIndexin interfaceMilvusClient- Parameters:
requestParam-CreateIndexParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
dropIndex
public R<RpcStatus> dropIndex(DropIndexParam requestParam)
Description copied from interface:MilvusClientDrops the index on a vector field in the specified collection.- Specified by:
dropIndexin interfaceMilvusClient- 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:MilvusClientShows the information of the specified index. Current release of Milvus only supports showing latest built index.- Specified by:
describeIndexin interfaceMilvusClient- 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:MilvusClientShows the index building state(in-progress/finished/failed), and the reason for failure (if any).- Specified by:
getIndexStatein interfaceMilvusClient- 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:MilvusClientShows the index building progress, such as how many rows are indexed.- Specified by:
getIndexBuildProgressin interfaceMilvusClient- 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:MilvusClientInserts entities into a specified collection . Note that you don't need to input primary key field if auto_id is enabled.- Specified by:
insertin interfaceMilvusClient- 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:MilvusClientInserts entities into a specified collection asynchronously. Note that you don't need to input primary key field if auto_id is enabled.- Specified by:
insertAsyncin interfaceMilvusClient- Parameters:
requestParam-InsertParam- Returns:
- a
ListenableFutureobject which holds the object {status:result code, data: MutationResult{insert results}}
-
upsert
public R<io.milvus.grpc.MutationResult> upsert(UpsertParam requestParam)
Description copied from interface:MilvusClientInsert new entities into a specified collection, replace them if the entities already exist.- Specified by:
upsertin interfaceMilvusClient- Parameters:
requestParam-UpsertParam- Returns:
- {status:result code, data: MutationResult{insert results}}
-
upsertAsync
public com.google.common.util.concurrent.ListenableFuture<R<io.milvus.grpc.MutationResult>> upsertAsync(UpsertParam requestParam)
Description copied from interface:MilvusClientInsert new entities into a specified collection asynchronously, replace them if the entities already exist.- Specified by:
upsertAsyncin interfaceMilvusClient- Parameters:
requestParam-UpsertParam- Returns:
- a
ListenableFutureobject 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:MilvusClientDeletes 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:
deletein interfaceMilvusClient- 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:MilvusClientConducts ANN search on a vector field. Use expression to do filtering before search.- Specified by:
searchin interfaceMilvusClient- 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:MilvusClientConducts ANN search on a vector field asynchronously. Use expression to do filtering before search.- Specified by:
searchAsyncin interfaceMilvusClient- Parameters:
requestParam-SearchParam- Returns:
- a
ListenableFutureobject 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:MilvusClientQueries entity(s) based on scalar field(s) filtered by boolean expression. Note that the order of the returned entities cannot be guaranteed.- Specified by:
queryin interfaceMilvusClient- 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:MilvusClientQueries 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:
queryAsyncin interfaceMilvusClient- 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:MilvusClientGets the runtime metrics information of Milvus, returns the result in .json format.- Specified by:
getMetricsin interfaceMilvusClient- 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:MilvusClientGet flush state of specified collection.- Specified by:
getFlushStatein interfaceMilvusClient- Parameters:
requestParam-GetFlushStateParam- Returns:
- {status:result code, data:GetMetricsResponse{status,metrics}}
-
getFlushAllState
public R<io.milvus.grpc.GetFlushAllStateResponse> getFlushAllState(GetFlushAllStateParam requestParam)
Description copied from interface:MilvusClientGet flush state of all segments.- Specified by:
getFlushAllStatein interfaceMilvusClient- Parameters:
requestParam-GetFlushAllStateParam- Returns:
- {status:result code, data:GetMetricsResponse{status,metrics}}
-
getPersistentSegmentInfo
public R<io.milvus.grpc.GetPersistentSegmentInfoResponse> getPersistentSegmentInfo(GetPersistentSegmentInfoParam requestParam)
Description copied from interface:MilvusClientGets the information of persistent segments from data node, including row count, persistence state(growing or flushed), etc.- Specified by:
getPersistentSegmentInfoin interfaceMilvusClient- 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:MilvusClientGets the query information of segments in a collection from query node, including row count, memory usage size, index name, etc.- Specified by:
getQuerySegmentInfoin interfaceMilvusClient- 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:MilvusClientReturns the collection's replica information- Specified by:
getReplicasin interfaceMilvusClient- Parameters:
requestParam-GetReplicasParam- Returns:
- {status:result code, data:GetReplicasResponse{status,info}}
-
loadBalance
public R<RpcStatus> loadBalance(LoadBalanceParam requestParam)
Description copied from interface:MilvusClientMoves segment from a query node to another to keep the load balanced.- Specified by:
loadBalancein interfaceMilvusClient- 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:MilvusClientGets the compaction state by id.- Specified by:
getCompactionStatein interfaceMilvusClient- 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:MilvusClientPerforms a manual compaction.- Specified by:
manualCompactin interfaceMilvusClient- 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:MilvusClientGets compaction state with its plan.- Specified by:
getCompactionStateWithPlansin interfaceMilvusClient- Parameters:
requestParam-GetCompactionPlansParam- Returns:
- {status:result code, data:GetCompactionPlansResponse{status,info}}
-
createCredential
public R<RpcStatus> createCredential(CreateCredentialParam requestParam)
Description copied from interface:MilvusClientCreate credential using the given user and password.- Specified by:
createCredentialin interfaceMilvusClient- Parameters:
requestParam-CreateCredentialParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
updateCredential
public R<RpcStatus> updateCredential(UpdateCredentialParam requestParam)
Description copied from interface:MilvusClientUpdate 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:
updateCredentialin interfaceMilvusClient- Parameters:
requestParam-UpdateCredentialParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
deleteCredential
public R<RpcStatus> deleteCredential(DeleteCredentialParam requestParam)
Description copied from interface:MilvusClientDelete credential corresponding to the user.- Specified by:
deleteCredentialin interfaceMilvusClient- 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:MilvusClientList all user names.- Specified by:
listCredUsersin interfaceMilvusClient- Parameters:
requestParam-ListCredUsersParam- Returns:
- {status:result code, data:ListCredUsersResponse{status,info}}
-
createRole
public R<RpcStatus> createRole(CreateRoleParam requestParam)
Description copied from interface:MilvusClientIt will success if the role isn't existed, otherwise fail.- Specified by:
createRolein interfaceMilvusClient- Parameters:
requestParam-CreateRoleParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
dropRole
public R<RpcStatus> dropRole(DropRoleParam requestParam)
Description copied from interface:MilvusClientIt will success if the role is existed, otherwise fail.- Specified by:
dropRolein interfaceMilvusClient- Parameters:
requestParam-DropRoleParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
addUserToRole
public R<RpcStatus> addUserToRole(AddUserToRoleParam requestParam)
Description copied from interface:MilvusClientThe user will get permissions that the role are allowed to perform operations.- Specified by:
addUserToRolein interfaceMilvusClient- Parameters:
requestParam-AddUserToRoleParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
removeUserFromRole
public R<RpcStatus> removeUserFromRole(RemoveUserFromRoleParam requestParam)
Description copied from interface:MilvusClientThe user will remove permissions that the role are allowed to perform operations.- Specified by:
removeUserFromRolein interfaceMilvusClient- Parameters:
requestParam-AddUserToRoleParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
selectRole
public R<io.milvus.grpc.SelectRoleResponse> selectRole(SelectRoleParam requestParam)
Description copied from interface:MilvusClientGet all users who are added to the role.- Specified by:
selectRolein interfaceMilvusClient- Parameters:
requestParam-SelectRoleParam- Returns:
- {status:result code, data:SelectRoleResponse{status,info}}
-
selectUser
public R<io.milvus.grpc.SelectUserResponse> selectUser(SelectUserParam requestParam)
Description copied from interface:MilvusClientGet all roles the user has.- Specified by:
selectUserin interfaceMilvusClient- Parameters:
requestParam-SelectUserParam- Returns:
- {status:result code, data:SelectUserResponse{status,info}}
-
grantRolePrivilege
public R<RpcStatus> grantRolePrivilege(GrantRolePrivilegeParam requestParam)
Description copied from interface:MilvusClientGrant Role Privilege.- Specified by:
grantRolePrivilegein interfaceMilvusClient- Parameters:
requestParam-GrantRolePrivilegeParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
revokeRolePrivilege
public R<RpcStatus> revokeRolePrivilege(RevokeRolePrivilegeParam requestParam)
Description copied from interface:MilvusClientRevoke Role Privilege.- Specified by:
revokeRolePrivilegein interfaceMilvusClient- Parameters:
requestParam-RevokeRolePrivilegeParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
selectGrantForRole
public R<io.milvus.grpc.SelectGrantResponse> selectGrantForRole(SelectGrantForRoleParam requestParam)
Description copied from interface:MilvusClientList a grant info for the role and the specific object- Specified by:
selectGrantForRolein interfaceMilvusClient- Parameters:
requestParam-SelectGrantForRoleParam- Returns:
- {status:result code, data:SelectRoleResponse{status,info}}
-
selectGrantForRoleAndObject
public R<io.milvus.grpc.SelectGrantResponse> selectGrantForRoleAndObject(SelectGrantForRoleAndObjectParam requestParam)
Description copied from interface:MilvusClientList a grant info for the role- Specified by:
selectGrantForRoleAndObjectin interfaceMilvusClient- Parameters:
requestParam-SelectGrantForRoleAndObjectParam- Returns:
- {status:result code, data:SelectRoleResponse{status,info}}
-
bulkInsert
public R<io.milvus.grpc.ImportResponse> bulkInsert(BulkInsertParam requestParam)
Description copied from interface:MilvusClientImport data from external files, currently support JSON format- Specified by:
bulkInsertin interfaceMilvusClient- Parameters:
requestParam-BulkInsertParam- Returns:
- {status:result code, data:ImportResponse{status,info}}
-
getBulkInsertState
public R<io.milvus.grpc.GetImportStateResponse> getBulkInsertState(GetBulkInsertStateParam requestParam)
Description copied from interface:MilvusClientGet state of bulk insert task- Specified by:
getBulkInsertStatein interfaceMilvusClient- Parameters:
requestParam-GetBulkInsertStateParam- Returns:
- {status:result code, data:GetImportStateResponse{status,info}}
-
listBulkInsertTasks
public R<io.milvus.grpc.ListImportTasksResponse> listBulkInsertTasks(ListBulkInsertTasksParam requestParam)
Description copied from interface:MilvusClientList bulk insert tasks- Specified by:
listBulkInsertTasksin interfaceMilvusClient- Parameters:
requestParam-ListBulkInsertTasksParam- Returns:
- {status:result code, data:ListImportTasksResponse{status,info}}
-
checkHealth
public R<io.milvus.grpc.CheckHealthResponse> checkHealth()
Description copied from interface:MilvusClientCheck server health- Specified by:
checkHealthin interfaceMilvusClient- Returns:
- {status:result code, data:CheckHealthResponse{status,info}}
-
getVersion
public R<io.milvus.grpc.GetVersionResponse> getVersion()
Description copied from interface:MilvusClientGet server version- Specified by:
getVersionin interfaceMilvusClient- Returns:
- {status:result code, data:GetVersionResponse{status,info}}
-
getLoadingProgress
public R<io.milvus.grpc.GetLoadingProgressResponse> getLoadingProgress(GetLoadingProgressParam requestParam)
Description copied from interface:MilvusClientGet collection loading progress- Specified by:
getLoadingProgressin interfaceMilvusClient- Parameters:
requestParam-GetLoadingProgressParam- Returns:
- {status:result code, data:GetLoadingProgressResponse{status}}
-
getLoadState
public R<io.milvus.grpc.GetLoadStateResponse> getLoadState(GetLoadStateParam requestParam)
Description copied from interface:MilvusClientGet collection loading state- Specified by:
getLoadStatein interfaceMilvusClient- Parameters:
requestParam-GetLoadStateParam- Returns:
- {status:result code, data:GetLoadStateResponse{status}}
-
createResourceGroup
public R<RpcStatus> createResourceGroup(CreateResourceGroupParam requestParam)
Description copied from interface:MilvusClientCreate a resource group.- Specified by:
createResourceGroupin interfaceMilvusClient- Parameters:
requestParam-CreateResourceGroupParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
dropResourceGroup
public R<RpcStatus> dropResourceGroup(DropResourceGroupParam requestParam)
Description copied from interface:MilvusClientDrop a resource group.- Specified by:
dropResourceGroupin interfaceMilvusClient- Parameters:
requestParam-DropResourceGroupParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
listResourceGroups
public R<io.milvus.grpc.ListResourceGroupsResponse> listResourceGroups(ListResourceGroupsParam requestParam)
Description copied from interface:MilvusClientList resource groups.- Specified by:
listResourceGroupsin interfaceMilvusClient- Parameters:
requestParam-ListResourceGroupsParam- Returns:
- {status:result code, data:ListResourceGroupsResponse{status}}
-
describeResourceGroup
public R<io.milvus.grpc.DescribeResourceGroupResponse> describeResourceGroup(DescribeResourceGroupParam requestParam)
Description copied from interface:MilvusClientDescribe a resource group.- Specified by:
describeResourceGroupin interfaceMilvusClient- Parameters:
requestParam-DescribeResourceGroupParam- Returns:
- {status:result code, data:DescribeResourceGroupResponse{status}}
-
transferNode
public R<RpcStatus> transferNode(TransferNodeParam requestParam)
Description copied from interface:MilvusClientTransfer a query node from source resource group to target resource_group.- Specified by:
transferNodein interfaceMilvusClient- Parameters:
requestParam-TransferNodeParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
transferReplica
public R<RpcStatus> transferReplica(TransferReplicaParam requestParam)
Description copied from interface:MilvusClientTransfer a replica from source resource group to target resource_group.- Specified by:
transferReplicain interfaceMilvusClient- Parameters:
requestParam-TransferReplicaParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
createCollection
public R<RpcStatus> createCollection(CreateSimpleCollectionParam requestParam)
Description copied from interface:MilvusClientCreates a collection in Milvus.- Specified by:
createCollectionin interfaceMilvusClient- Parameters:
requestParam-CreateSimpleCollectionParam- Returns:
- {status:result code, data:RpcStatus{msg: result message}}
-
listCollections
public R<ListCollectionsResponse> listCollections(ListCollectionsParam requestParam)
Description copied from interface:MilvusClientLists all collections- Specified by:
listCollectionsin interfaceMilvusClient- Parameters:
requestParam-ListCollectionsParam- Returns:
- {status:result code, data: ListCollectionsResponse{collection_names}}
-
insert
public R<InsertResponse> insert(InsertRowsParam requestParam)
Description copied from interface:MilvusClientInserts rows data into a specified collection . Note that you don't need to input primary key field if auto_id is enabled.- Specified by:
insertin interfaceMilvusClient- Parameters:
requestParam-InsertRowsParam- Returns:
- {status:result code, data: MutationResult{insert results}}
-
delete
public R<DeleteResponse> delete(DeleteIdsParam requestParam)
Description copied from interface:MilvusClientDeletes entity(s) based on the value of primary key.- Specified by:
deletein interfaceMilvusClient- Parameters:
requestParam-DeleteIdsParam- Returns:
- {status:result code, data: MutationResult{delete results}}
-
get
public R<GetResponse> get(GetIdsParam requestParam)
Description copied from interface:MilvusClientGet entity(s) based on the value of primary key.- Specified by:
getin interfaceMilvusClient- Parameters:
requestParam-GetIdsParam- Returns:
- {status:result code, data: QueryResults{query results}}
-
query
public R<QueryResponse> query(QuerySimpleParam requestParam)
Description copied from interface:MilvusClientQueries entity(s) based on scalar field(s) filtered by boolean expression. Note that the order of the returned entities cannot be guaranteed.- Specified by:
queryin interfaceMilvusClient- Parameters:
requestParam-QuerySimpleParam- Returns:
- {status:result code,data: QueryResults{filter results}}
-
search
public R<SearchResponse> search(SearchSimpleParam requestParam)
Description copied from interface:MilvusClientConducts ANN search on a vector field. Use expression to do filtering before search.- Specified by:
searchin interfaceMilvusClient- Parameters:
requestParam-SearchSimpleParam- Returns:
- {status:result code, data: SearchResults{topK results}}
-
queryIterator
public R<QueryIterator> queryIterator(QueryIteratorParam requestParam)
Description copied from interface:MilvusClientGet queryIterator based on scalar field(s) filtered by boolean expression. Note that the order of the returned entities cannot be guaranteed.- Specified by:
queryIteratorin interfaceMilvusClient- Parameters:
requestParam-QueryIteratorParam- Returns:
- {status:result code,data: QueryIterator}
-
searchIterator
public R<SearchIterator> searchIterator(SearchIteratorParam requestParam)
Description copied from interface:MilvusClientGet searchIterator based on a vector field. Use expression to do filtering before search.- Specified by:
searchIteratorin interfaceMilvusClient- Parameters:
requestParam-SearchIteratorParam- Returns:
- {status:result code, data: SearchIterator}
-
-