MilvusClient (io.milvus:milvus-sdk-java 2.1.0-beta2 API)

所有已知实现类:

AbstractMilvusGrpcClient, MilvusMultiServiceClient, MilvusServiceClient
```
public interface MilvusClient
```
The Milvus Client Interface

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`R<RpcStatus>`	`alterAlias(AlterAliasParam requestParam)` Alters alias from a collection to another.
`R<CalcDistanceResults>`	`calcDistance(CalcDistanceParam requestParam)` Calculates the distance between the specified vectors.
`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<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<FlushResponse>`	`flush(FlushParam requestParam)` Flushes collections.
`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<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<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<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>`	`manualCompaction(ManualCompactionParam 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<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<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.

- 方法详细资料
  - withTimeout
```
MilvusClient withTimeout(long timeout,
                         TimeUnit timeoutUnit)
```
    Timeout setting for rpc call.
    
    参数:
    
    timeout - set time waiting for a rpc call.
    
    timeoutUnit - time unit
  - close
```
default void close()
```
    Disconnects from a Milvus server with timeout of 1 minute
  - close
```
void close(long maxWaitSeconds)
    throws InterruptedException
```
    Disconnects from a Milvus server with configurable timeout.
    
    参数:
    
    maxWaitSeconds - timeout unit: second
    
    抛出:
    
    InterruptedException
  - hasCollection
```
R<Boolean> hasCollection(HasCollectionParam requestParam)
```
    Checks if a collection exists.
    
    参数:
    
    requestParam - HasCollectionParam
    
    返回:
    
    {status:result code, data: boolean, whether if has collection or not}
  - createCollection
```
R<RpcStatus> createCollection(CreateCollectionParam requestParam)
```
    Creates a collection in Milvus.
    
    参数:
    
    requestParam - CreateCollectionParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - dropCollection
```
R<RpcStatus> dropCollection(DropCollectionParam requestParam)
```
    Drops a collection. Note that this method drops all data in the collection.
    
    参数:
    
    requestParam - DropCollectionParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - loadCollection
```
R<RpcStatus> loadCollection(LoadCollectionParam requestParam)
```
    Loads a collection to memory before search or query.
    
    参数:
    
    requestParam - LoadCollectionParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - releaseCollection
```
R<RpcStatus> releaseCollection(ReleaseCollectionParam requestParam)
```
    Releases a collection from memory to reduce memory usage. Note that you cannot search while the corresponding collection is released from memory.
    
    参数:
    
    requestParam - ReleaseCollectionParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - describeCollection
```
R<DescribeCollectionResponse> describeCollection(DescribeCollectionParam requestParam)
```
    Shows the details of a collection, e.g. name, schema.
    
    参数:
    
    requestParam - DescribeCollectionParam
    
    返回:
    
    {status:result code, data:DescribeCollectionResponse{schema,collectionID}}
  - getCollectionStatistics
```
R<GetCollectionStatisticsResponse> getCollectionStatistics(GetCollectionStatisticsParam requestParam)
```
    Shows the statistics information of a collection.
    
    参数:
    
    requestParam - GetCollectionStatisticsParam
    
    返回:
    
    {status:result code, data: GetCollectionStatisticsResponse{status,stats}}
  - showCollections
```
R<ShowCollectionsResponse> showCollections(ShowCollectionsParam requestParam)
```
    Lists all collections or gets collection loading status.
    
    参数:
    
    requestParam - ShowCollectionsParam
    
    返回:
    
    {status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}
  - flush
```
R<FlushResponse> flush(FlushParam requestParam)
```
    Flushes collections. Currently we do not support this method on client since compaction is not supported on server.
    
    参数:
    
    requestParam - FlushParam
    
    返回:
    
    {status:result code,data: FlushResponse{flush segment ids}}
  - createPartition
```
R<RpcStatus> createPartition(CreatePartitionParam requestParam)
```
    Creates a partition in the specified collection.
    
    参数:
    
    requestParam - CreatePartitionParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - dropPartition
```
R<RpcStatus> dropPartition(DropPartitionParam requestParam)
```
    Drops a partition. Note that this method drops all data in this partition and the _default partition cannot be dropped.
    
    参数:
    
    requestParam - DropPartitionParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - hasPartition
```
R<Boolean> hasPartition(HasPartitionParam requestParam)
```
    Checks if a partition exists in the specified collection.
    
    参数:
    
    requestParam - HasPartitionParam
    
    返回:
    
    {status:result code, data: boolean, whether if has collection or not}
  - loadPartitions
```
R<RpcStatus> loadPartitions(LoadPartitionsParam requestParam)
```
    Loads a partition into memory.
    
    参数:
    
    requestParam - LoadPartitionsParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - releasePartitions
```
R<RpcStatus> releasePartitions(ReleasePartitionsParam requestParam)
```
    Releases a partition from memory.
    
    参数:
    
    requestParam - ReleasePartitionsParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - getPartitionStatistics
```
R<GetPartitionStatisticsResponse> getPartitionStatistics(GetPartitionStatisticsParam requestParam)
```
    Shows the statistics information of a partition.
    
    参数:
    
    requestParam - GetPartitionStatisticsParam
    
    返回:
    
    {status:result code,data:GetPartitionStatisticsResponse{status,stats}}
  - showPartitions
```
R<ShowPartitionsResponse> showPartitions(ShowPartitionsParam requestParam)
```
    Shows all partitions in the specified collection.
    
    参数:
    
    requestParam - ShowPartitionsParam
    
    返回:
    
    {status:result code, data:ShowPartitionsResponse{partition_names,partitionIDs,created_timestamps,created_utc_timestamps}}
  - createAlias
```
R<RpcStatus> createAlias(CreateAliasParam requestParam)
```
    Creates an alias for a collection. Alias can be used in search or query to replace the collection name
    
    参数:
    
    requestParam - CreateAliasParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - dropAlias
```
R<RpcStatus> dropAlias(DropAliasParam requestParam)
```
    Drops an alias for the specified collection.
    
    参数:
    
    requestParam - DropAliasParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - alterAlias
```
R<RpcStatus> alterAlias(AlterAliasParam requestParam)
```
    Alters alias from a collection to another.
    
    参数:
    
    requestParam - AlterAliasParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - createIndex
```
R<RpcStatus> createIndex(CreateIndexParam requestParam)
```
    Creates an index on a vector field in the specified collection. Note that index building is an async progress.
    
    参数:
    
    requestParam - CreateIndexParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - dropIndex
```
R<RpcStatus> dropIndex(DropIndexParam requestParam)
```
    Drops the index on a vector field in the specified collection.
    
    参数:
    
    requestParam - DropIndexParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - describeIndex
```
R<DescribeIndexResponse> describeIndex(DescribeIndexParam requestParam)
```
    Shows the information of the specified index. Current release of Milvus only supports showing latest built index.
    
    参数:
    
    requestParam - DescribeIndexParam
    
    返回:
    
    {status:result code, data:DescribeIndexResponse{status,index_descriptions}}
  - getIndexState
```
R<GetIndexStateResponse> getIndexState(GetIndexStateParam requestParam)
```
    Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).
    
    参数:
    
    requestParam - GetIndexStateParam
    
    返回:
    
    {status:result code, data:GetIndexStateResponse{status,state}}
  - getIndexBuildProgress
```
R<GetIndexBuildProgressResponse> getIndexBuildProgress(GetIndexBuildProgressParam requestParam)
```
    Shows the index building progress, such as how many rows are indexed.
    
    参数:
    
    requestParam - GetIndexBuildProgressParam
    
    返回:
    
    {status:result code, data:GetIndexBuildProgressResponse{status,indexed_rows}}
  - insert
```
R<MutationResult> insert(InsertParam requestParam)
```
    Inserts entities into a specified collection . Note that you don't need to input primary key field if auto_id is enabled.
    
    参数:
    
    requestParam - InsertParam
    
    返回:
    
    {status:result code, data: MutationResult{insert results}}
  - insertAsync
```
com.google.common.util.concurrent.ListenableFuture<R<MutationResult>> insertAsync(InsertParam requestParam)
```
    Inserts entities into a specified collection asynchronously. Note that you don't need to input primary key field if auto_id is enabled.
    
    参数:
    
    requestParam - InsertParam
    
    返回:
    
    a ListenableFuture object which holds the object {status:result code, data: MutationResult{insert results}}
  - delete
```
R<MutationResult> delete(DeleteParam requestParam)
```
    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, ...]"
    
    参数:
    
    requestParam - DeleteParam
    
    返回:
    
    {status:result code, data: MutationResult{delete results}}
  - search
```
R<SearchResults> search(SearchParam requestParam)
```
    Conducts ANN search on a vector field. Use expression to do filtering before search.
    
    参数:
    
    requestParam - SearchParam
    
    返回:
    
    {status:result code, data: SearchResults{topK results}}
  - searchAsync
```
com.google.common.util.concurrent.ListenableFuture<R<SearchResults>> searchAsync(SearchParam requestParam)
```
    Conducts ANN search on a vector field asynchronously. Use expression to do filtering before search.
    
    参数:
    
    requestParam - SearchParam
    
    返回:
    
    a ListenableFuture object which holds the object {status:result code, data: SearchResults{topK results}}
  - query
```
R<QueryResults> query(QueryParam requestParam)
```
    Queries entity(s) based on scalar field(s) filtered by boolean expression. Note that the order of the returned entities cannot be guaranteed.
    
    参数:
    
    requestParam - QueryParam
    
    返回:
    
    {status:result code,data: QueryResults{filter results}}
  - queryAsync
```
com.google.common.util.concurrent.ListenableFuture<R<QueryResults>> queryAsync(QueryParam requestParam)
```
    Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression. Note that the order of the returned entities cannot be guaranteed.
    
    参数:
    
    requestParam - QueryParam
    
    返回:
    
    {status:result code,data: QueryResults{filter results}}
  - calcDistance
```
R<CalcDistanceResults> calcDistance(CalcDistanceParam requestParam)
```
    Calculates the distance between the specified vectors.
    
    参数:
    
    requestParam - CalcDistanceParam
    
    返回:
    
    {status:result code, data: CalcDistanceResults{distances}}
  - getMetrics
```
R<GetMetricsResponse> getMetrics(GetMetricsParam requestParam)
```
    Gets the runtime metrics information of Milvus, returns the result in .json format.
    
    参数:
    
    requestParam - GetMetricsParam
    
    返回:
    
    {status:result code, data:GetMetricsResponse{status,metrics}}
  - getFlushState
```
R<GetFlushStateResponse> getFlushState(GetFlushStateParam requestParam)
```
    Get flush state of specified segments.
    
    参数:
    
    requestParam - GetFlushStateParam
    
    返回:
    
    {status:result code, data:GetMetricsResponse{status,metrics}}
  - getPersistentSegmentInfo
```
R<GetPersistentSegmentInfoResponse> getPersistentSegmentInfo(GetPersistentSegmentInfoParam requestParam)
```
    Gets the information of persistent segments from data node, including row count, persistence state(growing or flushed), etc.
    
    参数:
    
    requestParam - GetPersistentSegmentInfoParam
    
    返回:
    
    {status:result code, data:GetPersistentSegmentInfoResponse{status,info}}
  - getQuerySegmentInfo
```
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.
    
    参数:
    
    requestParam - GetQuerySegmentInfoParam
    
    返回:
    
    {status:result code, data:GetQuerySegmentInfoResponse{status,info}}
  - getReplicas
```
R<GetReplicasResponse> getReplicas(GetReplicasParam requestParam)
```
    Returns the collection's replica information
    
    参数:
    
    requestParam - GetReplicasParam
    
    返回:
    
    {status:result code, data:GetReplicasResponse{status,info}}
  - loadBalance
```
R<RpcStatus> loadBalance(LoadBalanceParam requestParam)
```
    Moves segment from a query node to another to keep the load balanced.
    
    参数:
    
    requestParam - LoadBalanceParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - getCompactionState
```
R<GetCompactionStateResponse> getCompactionState(GetCompactionStateParam requestParam)
```
    Gets the compaction state by id.
    
    参数:
    
    requestParam - GetCompactionStateParam
    
    返回:
    
    {status:result code, data:GetCompactionStateResponse{status,info}}
  - manualCompaction
```
R<ManualCompactionResponse> manualCompaction(ManualCompactionParam requestParam)
```
    Performs a manual compaction.
    
    参数:
    
    requestParam - ManualCompactionParam
    
    返回:
    
    {status:result code, data:ManualCompactionResponse{status,info}}
  - getCompactionStateWithPlans
```
R<GetCompactionPlansResponse> getCompactionStateWithPlans(GetCompactionPlansParam requestParam)
```
    Gets compaction state with its plan.
    
    参数:
    
    requestParam - GetCompactionPlansParam
    
    返回:
    
    {status:result code, data:GetCompactionPlansResponse{status,info}}
  - createCredential
```
R<RpcStatus> createCredential(CreateCredentialParam requestParam)
```
    Create credential using the given user and password.
    
    参数:
    
    requestParam - CreateCredentialParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - updateCredential
```
R<RpcStatus> updateCredential(UpdateCredentialParam requestParam)
```
    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.
    
    参数:
    
    requestParam - UpdateCredentialParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - deleteCredential
```
R<RpcStatus> deleteCredential(DeleteCredentialParam requestParam)
```
    Delete credential corresponding to the user.
    
    参数:
    
    requestParam - DeleteCredentialParam
    
    返回:
    
    {status:result code, data:RpcStatus{msg: result message}}
  - listCredUsers
```
R<ListCredUsersResponse> listCredUsers(ListCredUsersParam requestParam)
```
    List all user names.
    
    参数:
    
    requestParam - ListCredUsersParam
    
    返回:
    
    {status:result code, data:ListCredUsersResponse{status,info}}

接口 MilvusClient

方法概要

方法详细资料

withTimeout

close

close

hasCollection

createCollection

dropCollection

loadCollection

releaseCollection

describeCollection

getCollectionStatistics

showCollections

flush

createPartition

dropPartition

hasPartition

loadPartitions

releasePartitions

getPartitionStatistics

showPartitions

createAlias

dropAlias

alterAlias

createIndex

dropIndex

describeIndex

getIndexState

getIndexBuildProgress

insert

insertAsync

delete

search

searchAsync

query

queryAsync

calcDistance

getMetrics

getFlushState

getPersistentSegmentInfo

getQuerySegmentInfo

getReplicas

loadBalance

getCompactionState

manualCompaction

getCompactionStateWithPlans

createCredential

updateCredential

deleteCredential

listCredUsers