MilvusClient
MilvusServiceClient
public abstract class AbstractMilvusGrpcClient
extends java.lang.Object
implements MilvusClient
Constructor | Description |
---|---|
AbstractMilvusGrpcClient() |
Modifier and Type | Method | Description |
---|---|---|
R<RpcStatus> |
alterAlias(@NonNull AlterAliasParam requestParam) |
Alters alias from a collection to another.
|
protected abstract io.milvus.grpc.MilvusServiceGrpc.MilvusServiceBlockingStub |
blockingStub() |
|
R<io.milvus.grpc.CalcDistanceResults> |
calcDistance(@NonNull CalcDistanceParam requestParam) |
Calculates the distance between the specified vectors.
|
protected abstract boolean |
clientIsReady() |
|
R<RpcStatus> |
createAlias(@NonNull CreateAliasParam requestParam) |
Creates an alias for a collection.
|
R<RpcStatus> |
createCollection(@NonNull CreateCollectionParam requestParam) |
Creates a collection in Milvus.
|
R<RpcStatus> |
createIndex(@NonNull CreateIndexParam requestParam) |
Creates an index on a vector field in the specified collection.
|
R<RpcStatus> |
createPartition(@NonNull CreatePartitionParam requestParam) |
Creates a partition in the specified collection.
|
R<io.milvus.grpc.MutationResult> |
delete(@NonNull DeleteParam requestParam) |
Deletes entity(s) based on primary key(s) filtered by boolean expression.
|
R<io.milvus.grpc.DescribeCollectionResponse> |
describeCollection(@NonNull DescribeCollectionParam requestParam) |
Shows the details of a collection, e.g.
|
R<io.milvus.grpc.DescribeIndexResponse> |
describeIndex(@NonNull DescribeIndexParam requestParam) |
Shows the information of the specified index.
|
R<RpcStatus> |
dropAlias(@NonNull DropAliasParam requestParam) |
Drops an alias for the specified collection.
|
R<RpcStatus> |
dropCollection(@NonNull DropCollectionParam requestParam) |
Drops a collection.
|
R<RpcStatus> |
dropIndex(@NonNull DropIndexParam requestParam) |
Drops the index on a vector field in the specified collection.
|
R<RpcStatus> |
dropPartition(@NonNull DropPartitionParam requestParam) |
Drops a partition.
|
protected abstract io.milvus.grpc.MilvusServiceGrpc.MilvusServiceFutureStub |
futureStub() |
|
R<io.milvus.grpc.GetCollectionStatisticsResponse> |
getCollectionStatistics(@NonNull GetCollectionStatisticsParam requestParam) |
Shows the statistics information of a collection.
|
R<io.milvus.grpc.GetCompactionStateResponse> |
getCompactionState(GetCompactionStateParam requestParam) |
Gets the compaction state by id.
|
R<io.milvus.grpc.GetCompactionPlansResponse> |
getCompactionStateWithPlans(GetCompactionPlansParam requestParam) |
Gets compaction state with its plan.
|
R<io.milvus.grpc.GetFlushStateResponse> |
getFlushState(@NonNull GetFlushStateParam requestParam) |
Get flush state of specified segments.
|
R<io.milvus.grpc.GetIndexBuildProgressResponse> |
getIndexBuildProgress(@NonNull GetIndexBuildProgressParam requestParam) |
Shows the index building progress, such as how many rows are indexed.
|
R<io.milvus.grpc.GetIndexStateResponse> |
getIndexState(@NonNull GetIndexStateParam requestParam) |
Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).
|
R<io.milvus.grpc.GetMetricsResponse> |
getMetrics(@NonNull GetMetricsParam requestParam) |
Gets the runtime metrics information of Milvus, returns the result in .json format.
|
R<io.milvus.grpc.GetPartitionStatisticsResponse> |
getPartitionStatistics(@NonNull GetPartitionStatisticsParam requestParam) |
Shows the statistics information of a partition.
|
R<io.milvus.grpc.GetPersistentSegmentInfoResponse> |
getPersistentSegmentInfo(@NonNull 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(@NonNull GetQuerySegmentInfoParam requestParam) |
Gets the query information of segments in a collection from query node, including row count,
memory usage size, index name, etc.
|
R<java.lang.Boolean> |
hasCollection(@NonNull HasCollectionParam requestParam) |
Checks if a collection exists.
|
R<java.lang.Boolean> |
hasPartition(@NonNull HasPartitionParam requestParam) |
Checks if a partition exists in the specified collection.
|
R<io.milvus.grpc.MutationResult> |
insert(@NonNull InsertParam requestParam) |
Inserts entities into a specified collection.
|
R<RpcStatus> |
loadBalance(LoadBalanceParam requestParam) |
Moves segment from a query node to another to keep the load balanced.
|
R<RpcStatus> |
loadCollection(@NonNull LoadCollectionParam requestParam) |
Loads a collection to memory before search or query.
|
R<RpcStatus> |
loadPartitions(@NonNull LoadPartitionsParam requestParam) |
Loads a partition into memory.
|
R<io.milvus.grpc.ManualCompactionResponse> |
manualCompaction(ManualCompactionParam requestParam) |
Performs a manual compaction.
|
R<io.milvus.grpc.QueryResults> |
query(@NonNull QueryParam requestParam) |
Queries entity(s) based on scalar field(s) filtered by boolean expression.
|
R<RpcStatus> |
releaseCollection(@NonNull ReleaseCollectionParam requestParam) |
Releases a collection from memory to reduce memory usage.
|
R<RpcStatus> |
releasePartitions(@NonNull ReleasePartitionsParam requestParam) |
Releases a partition from memory.
|
R<io.milvus.grpc.SearchResults> |
search(@NonNull SearchParam requestParam) |
Conducts ANN search on a vector field.
|
R<io.milvus.grpc.ShowCollectionsResponse> |
showCollections(@NonNull ShowCollectionsParam requestParam) |
Lists all collections or gets collection loading status.
|
R<io.milvus.grpc.ShowPartitionsResponse> |
showPartitions(@NonNull ShowPartitionsParam requestParam) |
Shows all partitions in the specified collection.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close, close, withTimeout
public AbstractMilvusGrpcClient()
protected abstract io.milvus.grpc.MilvusServiceGrpc.MilvusServiceBlockingStub blockingStub()
protected abstract io.milvus.grpc.MilvusServiceGrpc.MilvusServiceFutureStub futureStub()
protected abstract boolean clientIsReady()
public R<java.lang.Boolean> hasCollection(@NonNull
@NonNull HasCollectionParam requestParam)
MilvusClient
hasCollection
in interface MilvusClient
requestParam
- HasCollectionParam
public R<RpcStatus> createCollection(@NonNull
@NonNull CreateCollectionParam requestParam)
MilvusClient
createCollection
in interface MilvusClient
requestParam
- CreateCollectionParam
public R<RpcStatus> dropCollection(@NonNull
@NonNull DropCollectionParam requestParam)
MilvusClient
dropCollection
in interface MilvusClient
requestParam
- DropCollectionParam
public R<RpcStatus> loadCollection(@NonNull
@NonNull LoadCollectionParam requestParam)
MilvusClient
loadCollection
in interface MilvusClient
requestParam
- LoadCollectionParam
public R<RpcStatus> releaseCollection(@NonNull
@NonNull ReleaseCollectionParam requestParam)
MilvusClient
releaseCollection
in interface MilvusClient
requestParam
- ReleaseCollectionParam
public R<io.milvus.grpc.DescribeCollectionResponse> describeCollection(@NonNull
@NonNull DescribeCollectionParam requestParam)
MilvusClient
describeCollection
in interface MilvusClient
requestParam
- DescribeCollectionParam
public R<io.milvus.grpc.GetCollectionStatisticsResponse> getCollectionStatistics(@NonNull
@NonNull GetCollectionStatisticsParam requestParam)
MilvusClient
getCollectionStatistics
in interface MilvusClient
requestParam
- GetCollectionStatisticsParam
public R<io.milvus.grpc.ShowCollectionsResponse> showCollections(@NonNull
@NonNull ShowCollectionsParam requestParam)
MilvusClient
showCollections
in interface MilvusClient
requestParam
- ShowCollectionsParam
public R<RpcStatus> createPartition(@NonNull
@NonNull CreatePartitionParam requestParam)
MilvusClient
createPartition
in interface MilvusClient
requestParam
- CreatePartitionParam
public R<RpcStatus> dropPartition(@NonNull
@NonNull DropPartitionParam requestParam)
MilvusClient
dropPartition
in interface MilvusClient
requestParam
- DropPartitionParam
public R<java.lang.Boolean> hasPartition(@NonNull
@NonNull HasPartitionParam requestParam)
MilvusClient
hasPartition
in interface MilvusClient
requestParam
- HasPartitionParam
public R<RpcStatus> loadPartitions(@NonNull
@NonNull LoadPartitionsParam requestParam)
MilvusClient
loadPartitions
in interface MilvusClient
requestParam
- LoadPartitionsParam
public R<RpcStatus> releasePartitions(@NonNull
@NonNull ReleasePartitionsParam requestParam)
MilvusClient
releasePartitions
in interface MilvusClient
requestParam
- ReleasePartitionsParam
public R<io.milvus.grpc.GetPartitionStatisticsResponse> getPartitionStatistics(@NonNull
@NonNull GetPartitionStatisticsParam requestParam)
MilvusClient
getPartitionStatistics
in interface MilvusClient
requestParam
- GetPartitionStatisticsParam
public R<io.milvus.grpc.ShowPartitionsResponse> showPartitions(@NonNull
@NonNull ShowPartitionsParam requestParam)
MilvusClient
showPartitions
in interface MilvusClient
requestParam
- ShowPartitionsParam
public R<RpcStatus> createAlias(@NonNull
@NonNull CreateAliasParam requestParam)
MilvusClient
createAlias
in interface MilvusClient
requestParam
- CreateAliasParam
public R<RpcStatus> dropAlias(@NonNull
@NonNull DropAliasParam requestParam)
MilvusClient
dropAlias
in interface MilvusClient
requestParam
- DropAliasParam
public R<RpcStatus> alterAlias(@NonNull
@NonNull AlterAliasParam requestParam)
MilvusClient
alterAlias
in interface MilvusClient
requestParam
- AlterAliasParam
public R<RpcStatus> createIndex(@NonNull
@NonNull CreateIndexParam requestParam)
MilvusClient
createIndex
in interface MilvusClient
requestParam
- CreateIndexParam
public R<RpcStatus> dropIndex(@NonNull
@NonNull DropIndexParam requestParam)
MilvusClient
dropIndex
in interface MilvusClient
requestParam
- DropIndexParam
public R<io.milvus.grpc.DescribeIndexResponse> describeIndex(@NonNull
@NonNull DescribeIndexParam requestParam)
MilvusClient
describeIndex
in interface MilvusClient
requestParam
- DescribeIndexParam
public R<io.milvus.grpc.GetIndexStateResponse> getIndexState(@NonNull
@NonNull GetIndexStateParam requestParam)
MilvusClient
getIndexState
in interface MilvusClient
requestParam
- GetIndexStateParam
public R<io.milvus.grpc.GetIndexBuildProgressResponse> getIndexBuildProgress(@NonNull
@NonNull GetIndexBuildProgressParam requestParam)
MilvusClient
getIndexBuildProgress
in interface MilvusClient
requestParam
- GetIndexBuildProgressParam
public R<io.milvus.grpc.MutationResult> delete(@NonNull
@NonNull DeleteParam requestParam)
MilvusClient
delete
in interface MilvusClient
requestParam
- DeleteParam
public R<io.milvus.grpc.MutationResult> insert(@NonNull
@NonNull InsertParam requestParam)
MilvusClient
insert
in interface MilvusClient
requestParam
- InsertParam
public R<io.milvus.grpc.SearchResults> search(@NonNull
@NonNull SearchParam requestParam)
MilvusClient
search
in interface MilvusClient
requestParam
- SearchParam
public R<io.milvus.grpc.QueryResults> query(@NonNull
@NonNull QueryParam requestParam)
MilvusClient
query
in interface MilvusClient
requestParam
- QueryParam
public R<io.milvus.grpc.CalcDistanceResults> calcDistance(@NonNull
@NonNull CalcDistanceParam requestParam)
MilvusClient
calcDistance
in interface MilvusClient
requestParam
- CalcDistanceParam
public R<io.milvus.grpc.GetMetricsResponse> getMetrics(@NonNull
@NonNull GetMetricsParam requestParam)
MilvusClient
getMetrics
in interface MilvusClient
requestParam
- GetMetricsParam
public R<io.milvus.grpc.GetFlushStateResponse> getFlushState(@NonNull
@NonNull GetFlushStateParam requestParam)
MilvusClient
getFlushState
in interface MilvusClient
requestParam
- GetFlushStateParam
public R<io.milvus.grpc.GetPersistentSegmentInfoResponse> getPersistentSegmentInfo(@NonNull
@NonNull GetPersistentSegmentInfoParam requestParam)
MilvusClient
getPersistentSegmentInfo
in interface MilvusClient
requestParam
- GetPersistentSegmentInfoParam
public R<io.milvus.grpc.GetQuerySegmentInfoResponse> getQuerySegmentInfo(@NonNull
@NonNull GetQuerySegmentInfoParam requestParam)
MilvusClient
getQuerySegmentInfo
in interface MilvusClient
requestParam
- GetQuerySegmentInfoParam
public R<RpcStatus> loadBalance(LoadBalanceParam requestParam)
MilvusClient
loadBalance
in interface MilvusClient
requestParam
- LoadBalanceParam
public R<io.milvus.grpc.GetCompactionStateResponse> getCompactionState(GetCompactionStateParam requestParam)
MilvusClient
getCompactionState
in interface MilvusClient
requestParam
- GetCompactionStateParam
public R<io.milvus.grpc.ManualCompactionResponse> manualCompaction(ManualCompactionParam requestParam)
MilvusClient
manualCompaction
in interface MilvusClient
requestParam
- ManualCompactionParam
public R<io.milvus.grpc.GetCompactionPlansResponse> getCompactionStateWithPlans(GetCompactionPlansParam requestParam)
MilvusClient
getCompactionStateWithPlans
in interface MilvusClient
requestParam
- GetCompactionPlansParam