public class MilvusMultiServiceClient extends Object implements MilvusClient
| 构造器和说明 |
|---|
MilvusMultiServiceClient(@NonNull MultiConnectParam multiConnectParam)
Sets connect param for multi milvus clusters.
|
| 限定符和类型 | 方法和说明 |
|---|---|
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<ImportResponse> |
bulkInsert(BulkInsertParam requestParam)
Import data from external files, currently support JSON format
|
R<CheckHealthResponse> |
checkHealth()
Check Server Health
|
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<RpcStatus> |
createRole(CreateRoleParam requestParam)
It will success if the role isn't existed, otherwise fail.
|
R<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<DescribeCollectionResponse> |
describeCollection(DescribeCollectionParam requestParam)
Shows the details of a collection, e.g. name, schema.
|
R<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<RpcStatus> |
dropRole(DropRoleParam requestParam)
It will success if the role is existed, otherwise fail.
|
R<FlushResponse> |
flush(FlushParam requestParam)
Flushes inserted data in buffer into storage.
|
R<GetImportStateResponse> |
getBulkInsertState(GetBulkInsertStateParam requestParam)
Get state of bulk insert task
|
R<GetCollectionStatisticsResponse> |
getCollectionStatistics(GetCollectionStatisticsParam requestParam)
Shows the statistics information of a collection.
|
R<GetCompactionStateResponse> |
getCompactionState(GetCompactionStateParam requestParam)
Gets the compaction state by id.
|
R<GetCompactionPlansResponse> |
getCompactionStateWithPlans(GetCompactionPlansParam requestParam)
Gets compaction state with its plan.
|
R<GetFlushStateResponse> |
getFlushState(GetFlushStateParam requestParam)
Get flush state of specified segments.
|
R<GetIndexBuildProgressResponse> |
getIndexBuildProgress(GetIndexBuildProgressParam requestParam)
Shows the index building progress, such as how many rows are indexed.
|
R<GetIndexStateResponse> |
getIndexState(GetIndexStateParam requestParam)
Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).
|
R<GetLoadingProgressResponse> |
getLoadingProgress(GetLoadingProgressParam requestParam)
Get Loading Collection Progress
|
R<GetMetricsResponse> |
getMetrics(GetMetricsParam requestParam)
Gets the runtime metrics information of Milvus, returns the result in .json format.
|
R<GetPartitionStatisticsResponse> |
getPartitionStatistics(GetPartitionStatisticsParam requestParam)
Shows the statistics information of a partition.
|
R<GetPersistentSegmentInfoResponse> |
getPersistentSegmentInfo(GetPersistentSegmentInfoParam requestParam)
Gets the information of persistent segments from data node, including row count,
persistence state(growing or flushed), etc.
|
R<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<GetReplicasResponse> |
getReplicas(GetReplicasParam requestParam)
Returns the collection's replica information
|
R<GetVersionResponse> |
getVersion()
Get Server Version
|
R<RpcStatus> |
grantRolePrivilege(GrantRolePrivilegeParam requestParam)
Grant Role Privilege.
|
R<Boolean> |
hasCollection(HasCollectionParam requestParam)
Checks if a collection exists.
|
R<Boolean> |
hasPartition(HasPartitionParam requestParam)
Checks if a partition exists in the specified collection.
|
R<MutationResult> |
insert(InsertParam requestParam)
Inserts entities into a specified collection .
|
com.google.common.util.concurrent.ListenableFuture<R<MutationResult>> |
insertAsync(InsertParam requestParam)
Inserts entities into a specified collection asynchronously.
|
R<ListImportTasksResponse> |
listBulkInsertTasks(ListBulkInsertTasksParam requestParam)
List bulk insert tasks
|
R<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<ManualCompactionResponse> |
manualCompact(ManualCompactParam requestParam)
Performs a manual compaction.
|
R<QueryResults> |
query(QueryParam requestParam)
Queries entity(s) based on scalar field(s) filtered by boolean expression.
|
com.google.common.util.concurrent.ListenableFuture<R<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<RpcStatus> |
removeUserFromRole(RemoveUserFromRoleParam requestParam)
The user will remove permissions that the role are allowed to perform operations.
|
R<RpcStatus> |
revokeRolePrivilege(RevokeRolePrivilegeParam requestParam)
Revoke Role Privilege.
|
R<SearchResults> |
search(SearchParam requestParam)
Conducts ANN search on a vector field.
|
com.google.common.util.concurrent.ListenableFuture<R<SearchResults>> |
searchAsync(SearchParam requestParam)
Conducts ANN search on a vector field asynchronously.
|
R<SelectGrantResponse> |
selectGrantForRole(SelectGrantForRoleParam requestParam)
List a grant info for the role and the specific object
|
R<SelectGrantResponse> |
selectGrantForRoleAndObject(SelectGrantForRoleAndObjectParam requestParam)
List a grant info for the role
|
R<SelectRoleResponse> |
selectRole(SelectRoleParam requestParam)
Get all users who are added to the role.
|
R<SelectUserResponse> |
selectUser(SelectUserParam requestParam)
Get all roles the user has.
|
R<ShowCollectionsResponse> |
showCollections(ShowCollectionsParam requestParam)
Lists all collections or gets collection loading status.
|
R<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,
TimeUnit timeoutUnit)
Timeout setting for rpc call.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclosepublic MilvusMultiServiceClient(@NonNull
@NonNull MultiConnectParam multiConnectParam)
multiConnectParam - multi server connect parampublic MilvusClient withTimeout(long timeout, TimeUnit timeoutUnit)
MilvusClientwithTimeout 在接口中 MilvusClienttimeout - set time waiting for a rpc call.timeoutUnit - time unitpublic void close(long maxWaitSeconds)
throws InterruptedException
MilvusClientclose 在接口中 MilvusClientmaxWaitSeconds - timeout unit: secondInterruptedExceptionpublic R<Boolean> hasCollection(HasCollectionParam requestParam)
MilvusClienthasCollection 在接口中 MilvusClientrequestParam - HasCollectionParampublic R<RpcStatus> createCollection(CreateCollectionParam requestParam)
MilvusClientcreateCollection 在接口中 MilvusClientrequestParam - CreateCollectionParampublic R<RpcStatus> dropCollection(DropCollectionParam requestParam)
MilvusClientdropCollection 在接口中 MilvusClientrequestParam - DropCollectionParampublic R<RpcStatus> loadCollection(LoadCollectionParam requestParam)
MilvusClientloadCollection 在接口中 MilvusClientrequestParam - LoadCollectionParampublic R<RpcStatus> releaseCollection(ReleaseCollectionParam requestParam)
MilvusClientreleaseCollection 在接口中 MilvusClientrequestParam - ReleaseCollectionParampublic R<DescribeCollectionResponse> describeCollection(DescribeCollectionParam requestParam)
MilvusClientdescribeCollection 在接口中 MilvusClientrequestParam - DescribeCollectionParampublic R<GetCollectionStatisticsResponse> getCollectionStatistics(GetCollectionStatisticsParam requestParam)
MilvusClientgetCollectionStatistics 在接口中 MilvusClientrequestParam - GetCollectionStatisticsParampublic R<ShowCollectionsResponse> showCollections(ShowCollectionsParam requestParam)
MilvusClientshowCollections 在接口中 MilvusClientrequestParam - ShowCollectionsParampublic R<FlushResponse> flush(FlushParam requestParam)
MilvusClientflush 在接口中 MilvusClientrequestParam - FlushParampublic R<RpcStatus> createPartition(CreatePartitionParam requestParam)
MilvusClientcreatePartition 在接口中 MilvusClientrequestParam - CreatePartitionParampublic R<RpcStatus> dropPartition(DropPartitionParam requestParam)
MilvusClientdropPartition 在接口中 MilvusClientrequestParam - DropPartitionParampublic R<Boolean> hasPartition(HasPartitionParam requestParam)
MilvusClienthasPartition 在接口中 MilvusClientrequestParam - HasPartitionParampublic R<RpcStatus> loadPartitions(LoadPartitionsParam requestParam)
MilvusClientloadPartitions 在接口中 MilvusClientrequestParam - LoadPartitionsParampublic R<RpcStatus> releasePartitions(ReleasePartitionsParam requestParam)
MilvusClientreleasePartitions 在接口中 MilvusClientrequestParam - ReleasePartitionsParampublic R<GetPartitionStatisticsResponse> getPartitionStatistics(GetPartitionStatisticsParam requestParam)
MilvusClientgetPartitionStatistics 在接口中 MilvusClientrequestParam - GetPartitionStatisticsParampublic R<ShowPartitionsResponse> showPartitions(ShowPartitionsParam requestParam)
MilvusClientshowPartitions 在接口中 MilvusClientrequestParam - ShowPartitionsParampublic R<RpcStatus> createAlias(CreateAliasParam requestParam)
MilvusClientcreateAlias 在接口中 MilvusClientrequestParam - CreateAliasParampublic R<RpcStatus> dropAlias(DropAliasParam requestParam)
MilvusClientdropAlias 在接口中 MilvusClientrequestParam - DropAliasParampublic R<RpcStatus> alterAlias(AlterAliasParam requestParam)
MilvusClientalterAlias 在接口中 MilvusClientrequestParam - AlterAliasParampublic R<RpcStatus> createIndex(CreateIndexParam requestParam)
MilvusClientcreateIndex 在接口中 MilvusClientrequestParam - CreateIndexParampublic R<RpcStatus> dropIndex(DropIndexParam requestParam)
MilvusClientdropIndex 在接口中 MilvusClientrequestParam - DropIndexParampublic R<DescribeIndexResponse> describeIndex(DescribeIndexParam requestParam)
MilvusClientdescribeIndex 在接口中 MilvusClientrequestParam - DescribeIndexParampublic R<GetIndexStateResponse> getIndexState(GetIndexStateParam requestParam)
MilvusClientgetIndexState 在接口中 MilvusClientrequestParam - GetIndexStateParampublic R<GetIndexBuildProgressResponse> getIndexBuildProgress(GetIndexBuildProgressParam requestParam)
MilvusClientgetIndexBuildProgress 在接口中 MilvusClientrequestParam - GetIndexBuildProgressParampublic R<MutationResult> insert(InsertParam requestParam)
MilvusClientinsert 在接口中 MilvusClientrequestParam - InsertParampublic com.google.common.util.concurrent.ListenableFuture<R<MutationResult>> insertAsync(InsertParam requestParam)
MilvusClientinsertAsync 在接口中 MilvusClientrequestParam - InsertParamListenableFuture object which holds the object {status:result code, data: MutationResult{insert results}}public R<MutationResult> delete(DeleteParam requestParam)
MilvusClientdelete 在接口中 MilvusClientrequestParam - DeleteParampublic R<SearchResults> search(SearchParam requestParam)
MilvusClientsearch 在接口中 MilvusClientrequestParam - SearchParampublic com.google.common.util.concurrent.ListenableFuture<R<SearchResults>> searchAsync(SearchParam requestParam)
MilvusClientsearchAsync 在接口中 MilvusClientrequestParam - SearchParamListenableFuture object which holds the object {status:result code, data: SearchResults{topK results}}public R<QueryResults> query(QueryParam requestParam)
MilvusClientquery 在接口中 MilvusClientrequestParam - QueryParampublic com.google.common.util.concurrent.ListenableFuture<R<QueryResults>> queryAsync(QueryParam requestParam)
MilvusClientqueryAsync 在接口中 MilvusClientrequestParam - QueryParampublic R<GetMetricsResponse> getMetrics(GetMetricsParam requestParam)
MilvusClientgetMetrics 在接口中 MilvusClientrequestParam - GetMetricsParampublic R<GetFlushStateResponse> getFlushState(GetFlushStateParam requestParam)
MilvusClientgetFlushState 在接口中 MilvusClientrequestParam - GetFlushStateParampublic R<GetPersistentSegmentInfoResponse> getPersistentSegmentInfo(GetPersistentSegmentInfoParam requestParam)
MilvusClientgetPersistentSegmentInfo 在接口中 MilvusClientrequestParam - GetPersistentSegmentInfoParampublic R<GetQuerySegmentInfoResponse> getQuerySegmentInfo(GetQuerySegmentInfoParam requestParam)
MilvusClientgetQuerySegmentInfo 在接口中 MilvusClientrequestParam - GetQuerySegmentInfoParampublic R<GetReplicasResponse> getReplicas(GetReplicasParam requestParam)
MilvusClientgetReplicas 在接口中 MilvusClientrequestParam - GetReplicasParampublic R<RpcStatus> loadBalance(LoadBalanceParam requestParam)
MilvusClientloadBalance 在接口中 MilvusClientrequestParam - LoadBalanceParampublic R<GetCompactionStateResponse> getCompactionState(GetCompactionStateParam requestParam)
MilvusClientgetCompactionState 在接口中 MilvusClientrequestParam - GetCompactionStateParampublic R<ManualCompactionResponse> manualCompact(ManualCompactParam requestParam)
MilvusClientmanualCompact 在接口中 MilvusClientrequestParam - ManualCompactParampublic R<GetCompactionPlansResponse> getCompactionStateWithPlans(GetCompactionPlansParam requestParam)
MilvusClientgetCompactionStateWithPlans 在接口中 MilvusClientrequestParam - GetCompactionPlansParampublic R<RpcStatus> createCredential(CreateCredentialParam requestParam)
MilvusClientcreateCredential 在接口中 MilvusClientrequestParam - CreateCredentialParampublic R<RpcStatus> updateCredential(UpdateCredentialParam requestParam)
MilvusClientupdateCredential 在接口中 MilvusClientrequestParam - UpdateCredentialParampublic R<RpcStatus> deleteCredential(DeleteCredentialParam requestParam)
MilvusClientdeleteCredential 在接口中 MilvusClientrequestParam - DeleteCredentialParampublic R<ListCredUsersResponse> listCredUsers(ListCredUsersParam requestParam)
MilvusClientlistCredUsers 在接口中 MilvusClientrequestParam - ListCredUsersParampublic R<RpcStatus> createRole(CreateRoleParam requestParam)
MilvusClientcreateRole 在接口中 MilvusClientrequestParam - CreateRoleParampublic R<RpcStatus> dropRole(DropRoleParam requestParam)
MilvusClientdropRole 在接口中 MilvusClientrequestParam - DropRoleParampublic R<RpcStatus> addUserToRole(AddUserToRoleParam requestParam)
MilvusClientaddUserToRole 在接口中 MilvusClientrequestParam - AddUserToRoleParampublic R<RpcStatus> removeUserFromRole(RemoveUserFromRoleParam requestParam)
MilvusClientremoveUserFromRole 在接口中 MilvusClientrequestParam - AddUserToRoleParampublic R<SelectRoleResponse> selectRole(SelectRoleParam requestParam)
MilvusClientselectRole 在接口中 MilvusClientrequestParam - SelectRoleParampublic R<SelectUserResponse> selectUser(SelectUserParam requestParam)
MilvusClientselectUser 在接口中 MilvusClientrequestParam - SelectUserParampublic R<RpcStatus> grantRolePrivilege(GrantRolePrivilegeParam requestParam)
MilvusClientgrantRolePrivilege 在接口中 MilvusClientrequestParam - GrantRolePrivilegeParampublic R<RpcStatus> revokeRolePrivilege(RevokeRolePrivilegeParam requestParam)
MilvusClientrevokeRolePrivilege 在接口中 MilvusClientrequestParam - RevokeRolePrivilegeParampublic R<SelectGrantResponse> selectGrantForRole(SelectGrantForRoleParam requestParam)
MilvusClientselectGrantForRole 在接口中 MilvusClientrequestParam - SelectGrantForRoleParampublic R<SelectGrantResponse> selectGrantForRoleAndObject(SelectGrantForRoleAndObjectParam requestParam)
MilvusClientselectGrantForRoleAndObject 在接口中 MilvusClientrequestParam - SelectGrantForRoleAndObjectParampublic R<ImportResponse> bulkInsert(BulkInsertParam requestParam)
MilvusClientbulkInsert 在接口中 MilvusClientrequestParam - BulkInsertParampublic R<GetImportStateResponse> getBulkInsertState(GetBulkInsertStateParam requestParam)
MilvusClientgetBulkInsertState 在接口中 MilvusClientrequestParam - GetBulkInsertStateParampublic R<ListImportTasksResponse> listBulkInsertTasks(ListBulkInsertTasksParam requestParam)
MilvusClientlistBulkInsertTasks 在接口中 MilvusClientrequestParam - ListBulkInsertTasksParampublic R<CheckHealthResponse> checkHealth()
MilvusClientcheckHealth 在接口中 MilvusClientpublic R<GetVersionResponse> getVersion()
MilvusClientgetVersion 在接口中 MilvusClientpublic R<GetLoadingProgressResponse> getLoadingProgress(GetLoadingProgressParam requestParam)
MilvusClientgetLoadingProgress 在接口中 MilvusClientrequestParam - GetLoadingProgressParamCopyright © 2023. All rights reserved.