Package io.milvus.client

Class MilvusGrpcClient

java.lang.Object

io.milvus.client.MilvusGrpcClient

All Implemented Interfaces:

MilvusClient

public class MilvusGrpcClient
extends java.lang.Object

Field Summary

Fields inherited from interface io.milvus.client.MilvusClient

clientVersion

Constructor Summary

Constructors

Constructor	Description
MilvusGrpcClient(ConnectParam connectParam)

Method Summary

Modifier and Type	Method	Description
protected io.milvus.grpc.MilvusServiceGrpc.MilvusServiceBlockingStub	blockingStub()
void	close(long maxWaitSeconds)	Close this MilvusClient.
Response	command(java.lang.String command)	Sends a command to server
Response	compact(java.lang.String collectionName)	Compacts the collection, erasing deleted data from disk and rebuild index in background (if the data size after compaction is still larger than indexFileSize).
com.google.common.util.concurrent.ListenableFuture<Response>	compactAsync(java.lang.String collectionName)	Compacts the collection asynchronously, erasing deleted data from disk and rebuild index in background (if the data size after compaction is still larger than indexFileSize).
CountEntitiesResponse	countEntities(java.lang.String collectionName)	Gets current entity count of a collection
Response	createCollection(CollectionMapping collectionMapping)	Creates collection specified by collectionMapping
Response	createIndex(Index index)	Creates index specified by index
com.google.common.util.concurrent.ListenableFuture<Response>	createIndexAsync(Index index)	Creates index specified by index asynchronously
Response	createPartition(java.lang.String collectionName, java.lang.String tag)	Creates a partition specified by collectionName and tag
Response	deleteEntityByID(java.lang.String collectionName, java.lang.String partitionTag, java.util.List<java.lang.Long> ids)	Deletes data in a collection by a list of ids
Response	dropCollection(java.lang.String collectionName)	Drops collection
Response	dropIndex(java.lang.String collectionName)	Drops collection index
Response	dropPartition(java.lang.String collectionName, java.lang.String tag)	Drops partition specified by collectionName and tag
Response	flush(java.lang.String collectionName)	Flushes data in a collection.
Response	flush(java.util.List<java.lang.String> collectionNames)	Flushes data in a list collections.
com.google.common.util.concurrent.ListenableFuture<Response>	flushAsync(java.lang.String collectionName)	Flushes data in a collection asynchronously.
com.google.common.util.concurrent.ListenableFuture<Response>	flushAsync(java.util.List<java.lang.String> collectionNames)	Flushes data in a list collections asynchronously.
protected io.milvus.grpc.MilvusServiceGrpc.MilvusServiceFutureStub	futureStub()
GetCollectionInfoResponse	getCollectionInfo(java.lang.String collectionName)	Gets collection info
Response	getCollectionStats(java.lang.String collectionName)	Shows collection information.
GetEntityByIDResponse	getEntityByID(java.lang.String collectionName, java.lang.String partitionTag, java.util.List<java.lang.Long> ids)	Gets vectors data by id array
GetIndexInfoResponse	getIndexInfo(java.lang.String collectionName)	Gets collection index information
Response	getServerStatus()	Get server status
Response	getServerVersion()	Get server version
HasCollectionResponse	hasCollection(java.lang.String collectionName)	Checks whether the collection exists
HasPartitionResponse	hasPartition(java.lang.String collectionName, java.lang.String tag)	Checks whether the partition exists
InsertResponse	insert(InsertParam insertParam)	Inserts data specified by insertParam
com.google.common.util.concurrent.ListenableFuture<InsertResponse>	insertAsync(InsertParam insertParam)	Inserts data specified by insertParam asynchronously
ListCollectionsResponse	listCollections()	Lists current collections
ListIDInSegmentResponse	listIDInSegment(java.lang.String collectionName, java.lang.String segmentName)	Gets all vector ids in a segment
ListPartitionsResponse	listPartitions(java.lang.String collectionName)	Lists current partitions of a collection
Response	loadCollection(java.lang.String collectionName)	Pre-loads collection to memory
Response	loadCollection(java.lang.String collectionName, java.util.List<java.lang.String> partitionTags)	Pre-loads collection/partitions to memory
protected boolean	maybeAvailable()
Response	releaseCollection(java.lang.String collectionName)	Release collection from memory
Response	releaseCollection(java.lang.String collectionName, java.util.List<java.lang.String> partitionTags)	Release collection/partitions from memory
SearchResponse	search(SearchParam searchParam)	Searches vectors specified by searchParam
com.google.common.util.concurrent.ListenableFuture<SearchResponse>	searchAsync(SearchParam searchParam)	Searches vectors specified by searchParam asynchronously
MilvusClient	withTimeout(long timeout, java.util.concurrent.TimeUnit timeoutUnit)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.milvus.client.MilvusClient

close, getClientVersion

Constructor Detail

MilvusGrpcClient

public MilvusGrpcClient(ConnectParam connectParam)

Method Detail

blockingStub

protected io.milvus.grpc.MilvusServiceGrpc.MilvusServiceBlockingStub blockingStub()

futureStub

protected io.milvus.grpc.MilvusServiceGrpc.MilvusServiceFutureStub futureStub()

maybeAvailable

protected boolean maybeAvailable()

close

public void close(long maxWaitSeconds)

Description copied from interface: MilvusClient

Close this MilvusClient. Wait at most `maxWaitSeconds` for graceful shutdown.

withTimeout

public MilvusClient withTimeout(long timeout,
                                java.util.concurrent.TimeUnit timeoutUnit)

createCollection

public Response createCollection(@Nonnull
                                 CollectionMapping collectionMapping)

Description copied from interface: MilvusClient

Creates collection specified by collectionMapping

Specified by:

createCollection in interface MilvusClient

Parameters:

collectionMapping - the CollectionMapping object

 example usage:
 
 CollectionMapping collectionMapping = new CollectionMapping.Builder(collectionName, dimension)
                                          .withIndexFileSize(1024)
                                          .withMetricType(MetricType.IP)
                                          .build();
 
 

Returns:

Response

See Also:

CollectionMapping, MetricType, Response

hasCollection

public HasCollectionResponse hasCollection(@Nonnull
                                           java.lang.String collectionName)

Description copied from interface: MilvusClient

Checks whether the collection exists

Specified by:

hasCollection in interface MilvusClient

Parameters:

collectionName - collection to check

Returns:

HasCollectionResponse

See Also:

HasCollectionResponse, Response

dropCollection

public Response dropCollection(@Nonnull
                               java.lang.String collectionName)

Description copied from interface: MilvusClient

Drops collection

Specified by:

dropCollection in interface MilvusClient

Parameters:

collectionName - collection to drop

Returns:

Response

See Also:

Response

createIndex

public Response createIndex(@Nonnull
                            Index index)

Description copied from interface: MilvusClient

Creates index specified by index

Specified by:

createIndex in interface MilvusClient

Parameters:

index - the Index object

 example usage:
 
 Index index = new Index.Builder(collectionName, IndexType.IVF_SQ8)
                        .withParamsInJson("{\"nlist\": 16384}")
                        .build();
 
 

Returns:

Response

See Also:

Index, IndexType, Response

createIndexAsync

public com.google.common.util.concurrent.ListenableFuture<Response> createIndexAsync(@Nonnull
                                                                                     Index index)

Description copied from interface: MilvusClient

Creates index specified by index asynchronously

Specified by:

createIndexAsync in interface MilvusClient

Parameters:

index - the Index object

 example usage:
 
 Index index = new Index.Builder(collectionName, IndexType.IVF_SQ8)
                        .withParamsInJson("{\"nlist\": 16384}")
                        .build();
 
 

Returns:

a ListenableFuture object which holds the Response

See Also:

Index, IndexType, Response, ListenableFuture

createPartition

public Response createPartition(java.lang.String collectionName,
                                java.lang.String tag)

Description copied from interface: MilvusClient

Creates a partition specified by collectionName and tag

Specified by:

createPartition in interface MilvusClient

Parameters:

collectionName - collection name

tag - partition tag

Returns:

Response

See Also:

Response

hasPartition

public HasPartitionResponse hasPartition(java.lang.String collectionName,
                                         java.lang.String tag)

Description copied from interface: MilvusClient

Checks whether the partition exists

Specified by:

hasPartition in interface MilvusClient

Parameters:

collectionName - collection name

tag - partition tag

Returns:

HasPartitionResponse

See Also:

Response

listPartitions

public ListPartitionsResponse listPartitions(java.lang.String collectionName)

Description copied from interface: MilvusClient

Lists current partitions of a collection

Specified by:

listPartitions in interface MilvusClient

Parameters:

collectionName - collection name

Returns:

ListPartitionsResponse

See Also:

ListPartitionsResponse, Response

dropPartition

public Response dropPartition(java.lang.String collectionName,
                              java.lang.String tag)

Description copied from interface: MilvusClient

Drops partition specified by collectionName and tag

Specified by:

dropPartition in interface MilvusClient

Parameters:

collectionName - collection name

tag - partition tag

See Also:

Response

insert

public InsertResponse insert(@Nonnull
                             InsertParam insertParam)

Description copied from interface: MilvusClient

Inserts data specified by insertParam

Specified by:

insert in interface MilvusClient

Parameters:

insertParam - the InsertParam object

 example usage:
 
 InsertParam insertParam = new InsertParam.Builder(collectionName)
                                          .withFloatVectors(floatVectors)
                                          .withVectorIds(vectorIds)
                                          .withPartitionTag(tag)
                                          .build();
 
 

Returns:

InsertResponse

See Also:

InsertParam, InsertResponse, Response

insertAsync

public com.google.common.util.concurrent.ListenableFuture<InsertResponse> insertAsync(@Nonnull
                                                                                      InsertParam insertParam)

Description copied from interface: MilvusClient

Inserts data specified by insertParam asynchronously

Specified by:

insertAsync in interface MilvusClient

Parameters:

insertParam - the InsertParam object

 example usage:
 
 InsertParam insertParam = new InsertParam.Builder(collectionName)
                                          .withFloatVectors(floatVectors)
                                          .withVectorIds(vectorIds)
                                          .withPartitionTag(tag)
                                          .build();
 
 

Returns:

a ListenableFuture object which holds the InsertResponse

See Also:

InsertParam, InsertResponse, Response, ListenableFuture

search

public SearchResponse search(@Nonnull
                             SearchParam searchParam)

Description copied from interface: MilvusClient

Searches vectors specified by searchParam

Specified by:

search in interface MilvusClient

Parameters:

searchParam - the SearchParam object

 example usage:
 
 SearchParam searchParam = new SearchParam.Builder(collectionName)
                                          .withFloatVectors(floatVectors)
                                          .withTopK(topK)
                                          .withPartitionTags(partitionTagsList)
                                          .withParamsInJson("{\"nprobe\": 20}")
                                          .build();
 
 

Returns:

SearchResponse

See Also:

SearchParam, SearchResponse, SearchResponse.QueryResult, Response

searchAsync

public com.google.common.util.concurrent.ListenableFuture<SearchResponse> searchAsync(@Nonnull
                                                                                      SearchParam searchParam)

Description copied from interface: MilvusClient

Searches vectors specified by searchParam asynchronously

Specified by:

searchAsync in interface MilvusClient

Parameters:

searchParam - the SearchParam object

 example usage:
 
 SearchParam searchParam = new SearchParam.Builder(collectionName)
                                          .withFloatVectors(floatVectors)
                                          .withTopK(topK)
                                          .withPartitionTags(partitionTagsList)
                                          .withParamsInJson("{\"nprobe\": 20}")
                                          .build();
 
 

Returns:

a ListenableFuture object which holds the SearchResponse

See Also:

SearchParam, SearchResponse, SearchResponse.QueryResult, Response, ListenableFuture

getCollectionInfo

public GetCollectionInfoResponse getCollectionInfo(@Nonnull
                                                   java.lang.String collectionName)

Description copied from interface: MilvusClient

Gets collection info

Specified by:

getCollectionInfo in interface MilvusClient

Parameters:

collectionName - collection to describe

See Also:

GetCollectionInfoResponse, CollectionMapping, Response

listCollections

public ListCollectionsResponse listCollections()

Description copied from interface: MilvusClient

Lists current collections

Specified by:

listCollections in interface MilvusClient

Returns:

ListCollectionsResponse

See Also:

ListCollectionsResponse, Response

countEntities

public CountEntitiesResponse countEntities(@Nonnull
                                           java.lang.String collectionName)

Description copied from interface: MilvusClient

Gets current entity count of a collection

Specified by:

countEntities in interface MilvusClient

Parameters:

collectionName - collection to count entities

Returns:

CountEntitiesResponse

See Also:

CountEntitiesResponse, Response

getServerStatus

public Response getServerStatus()

Description copied from interface: MilvusClient

Get server status

Specified by:

getServerStatus in interface MilvusClient

Returns:

Response

See Also:

Response

getServerVersion

public Response getServerVersion()

Description copied from interface: MilvusClient

Get server version

Specified by:

getServerVersion in interface MilvusClient

Returns:

Response

See Also:

Response

command

public Response command(@Nonnull
                        java.lang.String command)

Description copied from interface: MilvusClient

Sends a command to server

Specified by:

command in interface MilvusClient

Returns:

Response command's response will be return in message

See Also:

Response

loadCollection

public Response loadCollection(@Nonnull
                               java.lang.String collectionName)

Description copied from interface: MilvusClient

Pre-loads collection to memory

Specified by:

loadCollection in interface MilvusClient

Parameters:

collectionName - collection to load

Returns:

Response

See Also:

Response

loadCollection

public Response loadCollection(@Nonnull
                               java.lang.String collectionName,
                               java.util.List<java.lang.String> partitionTags)

Description copied from interface: MilvusClient

Pre-loads collection/partitions to memory

Specified by:

loadCollection in interface MilvusClient

Parameters:

collectionName - collection to load

partitionTags - partitions to load

Returns:

Response

See Also:

Response

releaseCollection

public Response releaseCollection(java.lang.String collectionName)

Description copied from interface: MilvusClient

Release collection from memory

Specified by:

releaseCollection in interface MilvusClient

Parameters:

collectionName - collection to release

Returns:

Response

See Also:

Response

releaseCollection

public Response releaseCollection(java.lang.String collectionName,
                                  java.util.List<java.lang.String> partitionTags)

Description copied from interface: MilvusClient

Release collection/partitions from memory

Specified by:

releaseCollection in interface MilvusClient

Parameters:

collectionName - collection to release

partitionTags - partitions to release

Returns:

Response

See Also:

Response

getIndexInfo

public GetIndexInfoResponse getIndexInfo(@Nonnull
                                         java.lang.String collectionName)

Description copied from interface: MilvusClient

Gets collection index information

Specified by:

getIndexInfo in interface MilvusClient

Parameters:

collectionName - collection to get info from

See Also:

GetIndexInfoResponse, Index, Response

dropIndex

public Response dropIndex(@Nonnull
                          java.lang.String collectionName)

Description copied from interface: MilvusClient

Drops collection index

Specified by:

dropIndex in interface MilvusClient

Parameters:

collectionName - collection to drop index of

Returns:

Response

See Also:

Response

getCollectionStats

public Response getCollectionStats(java.lang.String collectionName)

Description copied from interface: MilvusClient

Shows collection information. A collection consists of one or multiple partitions (including the default partition), and a partitions consists of one or more segments. Each partition or segment can be uniquely identified by its partition tag or segment name respectively. The result will be returned as JSON string.

Specified by:

getCollectionStats in interface MilvusClient

Parameters:

collectionName - collection to show info from

Returns:

Response

See Also:

Response

getEntityByID

public GetEntityByIDResponse getEntityByID(java.lang.String collectionName,
                                           java.lang.String partitionTag,
                                           java.util.List<java.lang.Long> ids)

Description copied from interface: MilvusClient

Gets vectors data by id array

Specified by:

getEntityByID in interface MilvusClient

Parameters:

collectionName - collection to get vectors from

partitionTag - partition to get vectors from

ids - a List of vector ids

Returns:

GetEntityByIDResponse

See Also:

GetEntityByIDResponse, Response

listIDInSegment

public ListIDInSegmentResponse listIDInSegment(java.lang.String collectionName,
                                               java.lang.String segmentName)

Description copied from interface: MilvusClient

Gets all vector ids in a segment

Specified by:

listIDInSegment in interface MilvusClient

Parameters:

collectionName - collection to get vector ids from

segmentName - segment name in the collection

Returns:

ListIDInSegmentResponse

See Also:

ListIDInSegmentResponse, Response

deleteEntityByID

public Response deleteEntityByID(java.lang.String collectionName,
                                 java.lang.String partitionTag,
                                 java.util.List<java.lang.Long> ids)

Description copied from interface: MilvusClient

Deletes data in a collection by a list of ids

Specified by:

deleteEntityByID in interface MilvusClient

Parameters:

collectionName - collection to delete ids from

partitionTag - partition to delete ids from

ids - a List of vector ids to delete

Returns:

Response

See Also:

Response

flush

public Response flush(java.util.List<java.lang.String> collectionNames)

Description copied from interface: MilvusClient

Flushes data in a list collections. Newly inserted or modifications on data will be visible after flush returned

Specified by:

flush in interface MilvusClient

Parameters:

collectionNames - a List of collections to flush

Returns:

Response

See Also:

Response

flushAsync

public com.google.common.util.concurrent.ListenableFuture<Response> flushAsync(@Nonnull
                                                                               java.util.List<java.lang.String> collectionNames)

Description copied from interface: MilvusClient

Flushes data in a list collections asynchronously. Newly inserted or modifications on data will be visible after flush returned

Specified by:

flushAsync in interface MilvusClient

Parameters:

collectionNames - a List of collections to flush

Returns:

a ListenableFuture object which holds the Response

See Also:

Response, ListenableFuture

flush

public Response flush(java.lang.String collectionName)

Description copied from interface: MilvusClient

Flushes data in a collection. Newly inserted or modifications on data will be visible after flush returned

Specified by:

flush in interface MilvusClient

Parameters:

collectionName - name of collection to flush

Returns:

Response

See Also:

Response

flushAsync

public com.google.common.util.concurrent.ListenableFuture<Response> flushAsync(java.lang.String collectionName)

Description copied from interface: MilvusClient

Flushes data in a collection asynchronously. Newly inserted or modifications on data will be visible after flush returned

Specified by:

flushAsync in interface MilvusClient

Parameters:

collectionName - name of collection to flush

Returns:

a ListenableFuture object which holds the Response

See Also:

Response, ListenableFuture

compact

public Response compact(java.lang.String collectionName)

Description copied from interface: MilvusClient

Compacts the collection, erasing deleted data from disk and rebuild index in background (if the data size after compaction is still larger than indexFileSize). Data was only soft-deleted until you call compact.

Specified by:

compact in interface MilvusClient

Parameters:

collectionName - name of collection to compact

Returns:

Response

See Also:

Response

compactAsync

public com.google.common.util.concurrent.ListenableFuture<Response> compactAsync(@Nonnull
                                                                                 java.lang.String collectionName)

Description copied from interface: MilvusClient

Compacts the collection asynchronously, erasing deleted data from disk and rebuild index in background (if the data size after compaction is still larger than indexFileSize). Data was only soft-deleted until you call compact.

Specified by:

compactAsync in interface MilvusClient

Parameters:

collectionName - name of collection to compact

Returns:

a ListenableFuture object which holds the Response

See Also:

Response, ListenableFuture