public interface MilvusClient
| 限定符和类型 | 方法和说明 |
|---|---|
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
|
default void |
close()
Disconnects from a Milvus server with timeout of 1 minute
|
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.
|
MilvusClient withTimeout(long timeout, TimeUnit timeoutUnit)
timeout - set time waiting for a rpc call.timeoutUnit - time unitdefault void close()
void close(long maxWaitSeconds)
throws InterruptedException
maxWaitSeconds - timeout unit: secondInterruptedExceptionR<Boolean> hasCollection(HasCollectionParam requestParam)
requestParam - HasCollectionParamR<RpcStatus> createCollection(CreateCollectionParam requestParam)
requestParam - CreateCollectionParamR<RpcStatus> dropCollection(DropCollectionParam requestParam)
requestParam - DropCollectionParamR<RpcStatus> loadCollection(LoadCollectionParam requestParam)
requestParam - LoadCollectionParamR<RpcStatus> releaseCollection(ReleaseCollectionParam requestParam)
requestParam - ReleaseCollectionParamR<DescribeCollectionResponse> describeCollection(DescribeCollectionParam requestParam)
requestParam - DescribeCollectionParamR<GetCollectionStatisticsResponse> getCollectionStatistics(GetCollectionStatisticsParam requestParam)
requestParam - GetCollectionStatisticsParamR<ShowCollectionsResponse> showCollections(ShowCollectionsParam requestParam)
requestParam - ShowCollectionsParamR<FlushResponse> flush(FlushParam requestParam)
requestParam - FlushParamR<RpcStatus> createPartition(CreatePartitionParam requestParam)
requestParam - CreatePartitionParamR<RpcStatus> dropPartition(DropPartitionParam requestParam)
requestParam - DropPartitionParamR<Boolean> hasPartition(HasPartitionParam requestParam)
requestParam - HasPartitionParamR<RpcStatus> loadPartitions(LoadPartitionsParam requestParam)
requestParam - LoadPartitionsParamR<RpcStatus> releasePartitions(ReleasePartitionsParam requestParam)
requestParam - ReleasePartitionsParamR<GetPartitionStatisticsResponse> getPartitionStatistics(GetPartitionStatisticsParam requestParam)
requestParam - GetPartitionStatisticsParamR<ShowPartitionsResponse> showPartitions(ShowPartitionsParam requestParam)
requestParam - ShowPartitionsParamR<RpcStatus> createAlias(CreateAliasParam requestParam)
requestParam - CreateAliasParamR<RpcStatus> dropAlias(DropAliasParam requestParam)
requestParam - DropAliasParamR<RpcStatus> alterAlias(AlterAliasParam requestParam)
requestParam - AlterAliasParamR<RpcStatus> createIndex(CreateIndexParam requestParam)
requestParam - CreateIndexParamR<RpcStatus> dropIndex(DropIndexParam requestParam)
requestParam - DropIndexParamR<DescribeIndexResponse> describeIndex(DescribeIndexParam requestParam)
requestParam - DescribeIndexParamR<GetIndexStateResponse> getIndexState(GetIndexStateParam requestParam)
requestParam - GetIndexStateParamR<GetIndexBuildProgressResponse> getIndexBuildProgress(GetIndexBuildProgressParam requestParam)
requestParam - GetIndexBuildProgressParamR<MutationResult> insert(InsertParam requestParam)
requestParam - InsertParamcom.google.common.util.concurrent.ListenableFuture<R<MutationResult>> insertAsync(InsertParam requestParam)
requestParam - InsertParamListenableFuture object which holds the object {status:result code, data: MutationResult{insert results}}R<MutationResult> delete(DeleteParam requestParam)
requestParam - DeleteParamR<SearchResults> search(SearchParam requestParam)
requestParam - SearchParamcom.google.common.util.concurrent.ListenableFuture<R<SearchResults>> searchAsync(SearchParam requestParam)
requestParam - SearchParamListenableFuture object which holds the object {status:result code, data: SearchResults{topK results}}R<QueryResults> query(QueryParam requestParam)
requestParam - QueryParamcom.google.common.util.concurrent.ListenableFuture<R<QueryResults>> queryAsync(QueryParam requestParam)
requestParam - QueryParamR<GetMetricsResponse> getMetrics(GetMetricsParam requestParam)
requestParam - GetMetricsParamR<GetFlushStateResponse> getFlushState(GetFlushStateParam requestParam)
requestParam - GetFlushStateParamR<GetPersistentSegmentInfoResponse> getPersistentSegmentInfo(GetPersistentSegmentInfoParam requestParam)
requestParam - GetPersistentSegmentInfoParamR<GetQuerySegmentInfoResponse> getQuerySegmentInfo(GetQuerySegmentInfoParam requestParam)
requestParam - GetQuerySegmentInfoParamR<GetReplicasResponse> getReplicas(GetReplicasParam requestParam)
requestParam - GetReplicasParamR<RpcStatus> loadBalance(LoadBalanceParam requestParam)
requestParam - LoadBalanceParamR<GetCompactionStateResponse> getCompactionState(GetCompactionStateParam requestParam)
requestParam - GetCompactionStateParamR<ManualCompactionResponse> manualCompact(ManualCompactParam requestParam)
requestParam - ManualCompactParamR<GetCompactionPlansResponse> getCompactionStateWithPlans(GetCompactionPlansParam requestParam)
requestParam - GetCompactionPlansParamR<RpcStatus> createCredential(CreateCredentialParam requestParam)
requestParam - CreateCredentialParamR<RpcStatus> updateCredential(UpdateCredentialParam requestParam)
requestParam - UpdateCredentialParamR<RpcStatus> deleteCredential(DeleteCredentialParam requestParam)
requestParam - DeleteCredentialParamR<ListCredUsersResponse> listCredUsers(ListCredUsersParam requestParam)
requestParam - ListCredUsersParamR<RpcStatus> createRole(CreateRoleParam requestParam)
requestParam - CreateRoleParamR<RpcStatus> dropRole(DropRoleParam requestParam)
requestParam - DropRoleParamR<RpcStatus> addUserToRole(AddUserToRoleParam requestParam)
requestParam - AddUserToRoleParamR<RpcStatus> removeUserFromRole(RemoveUserFromRoleParam requestParam)
requestParam - AddUserToRoleParamR<SelectRoleResponse> selectRole(SelectRoleParam requestParam)
requestParam - SelectRoleParamR<SelectUserResponse> selectUser(SelectUserParam requestParam)
requestParam - SelectUserParamR<RpcStatus> grantRolePrivilege(GrantRolePrivilegeParam requestParam)
requestParam - GrantRolePrivilegeParamR<RpcStatus> revokeRolePrivilege(RevokeRolePrivilegeParam requestParam)
requestParam - RevokeRolePrivilegeParamR<SelectGrantResponse> selectGrantForRole(SelectGrantForRoleParam requestParam)
requestParam - SelectGrantForRoleParamR<SelectGrantResponse> selectGrantForRoleAndObject(SelectGrantForRoleAndObjectParam requestParam)
requestParam - SelectGrantForRoleAndObjectParamR<ImportResponse> bulkInsert(BulkInsertParam requestParam)
requestParam - BulkInsertParamR<GetImportStateResponse> getBulkInsertState(GetBulkInsertStateParam requestParam)
requestParam - GetBulkInsertStateParamR<ListImportTasksResponse> listBulkInsertTasks(ListBulkInsertTasksParam requestParam)
requestParam - ListBulkInsertTasksParamR<CheckHealthResponse> checkHealth()
R<GetVersionResponse> getVersion()
R<GetLoadingProgressResponse> getLoadingProgress(GetLoadingProgressParam requestParam)
requestParam - GetLoadingProgressParamCopyright © 2023. All rights reserved.