Package io.milvus.client

Class MilvusGrpcClient

java.lang.Object

io.milvus.client.MilvusGrpcClient

All Implemented Interfaces:

MilvusClient

public class MilvusGrpcClient
extends Object
implements MilvusClient

Actual implementation of interface MilvusClient

Field Summary

Fields inherited from interface io.milvus.client.MilvusClient

clientVersion

Constructor Summary

Constructors

Constructor	Description
MilvusGrpcClient()
MilvusGrpcClient(Level logLevel)

Method Summary

Modifier and Type	Method	Description
Response	command(String command)	Sends a command to server
Response	compact(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).
Response	connect(ConnectParam connectParam)	Connects to Milvus server
Response	createCollection(CollectionMapping collectionMapping)	Creates collection specified by collectionMapping
Response	createIndex(Index index)	Creates index specified by index
Response	createPartition(String collectionName, String tag)	Creates a partition specified by collectionName and tag
Response	deleteById(String collectionName, Long id)	Deletes data in a collection by a single id
Response	deleteByIds(String collectionName, List<Long> ids)	Deletes data in a collection by a list of ids
DescribeCollectionResponse	describeCollection(String collectionName)	Describes the collection
DescribeIndexResponse	describeIndex(String collectionName)	Describes collection index
Response	disconnect()	Disconnects from Milvus server
Response	dropCollection(String collectionName)	Drops collection
Response	dropIndex(String collectionName)	Drops collection index
Response	dropPartition(String collectionName, String tag)	Drops partition specified by collectionName and tag
Response	flush(String collectionName)	Flushes data in a collection.
Response	flush(List<String> collectionNames)	Flushes data in a list collections.
GetCollectionRowCountResponse	getCollectionRowCount(String collectionName)	Gets current row count of a collection
Response	getServerStatus()	Get server status
Response	getServerVersion()	Get server version
GetVectorByIdResponse	getVectorById(String collectionName, Long id)	Gets either a float or binary vector by id.
GetVectorIdsResponse	getVectorIds(String collectionName, String segmentName)	Gets all vector ids in a segment
HasCollectionResponse	hasCollection(String collectionName)	Checks whether the collection exists
InsertResponse	insert(InsertParam insertParam)	Inserts data specified by insertParam
boolean	isConnected()
Response	preloadCollection(String collectionName)	Pre-loads collection to memory
SearchResponse	search(SearchParam searchParam)	Searches vectors specified by searchParam
SearchResponse	searchInFiles(List<String> fileIds, SearchParam searchParam)	Searches vectors in specific files
ShowCollectionInfoResponse	showCollectionInfo(String collectionName)	Shows collection information.
ShowCollectionsResponse	showCollections()	Shows current collections
ShowPartitionsResponse	showPartitions(String collectionName)	Shows current partitions of a collection

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

getClientVersion

Constructor Detail

MilvusGrpcClient

public MilvusGrpcClient()

MilvusGrpcClient

public MilvusGrpcClient(Level logLevel)

Parameters:

logLevel - we currently have three levels of logs: INFO, WARNING and SEVERE. You can also specify to be Level.All or Level.OFF

See Also:

Level

Method Detail

connect

public Response connect(ConnectParam connectParam)
                 throws ConnectFailedException

Description copied from interface: MilvusClient

Connects to Milvus server

Specified by:

connect in interface MilvusClient

Parameters:

connectParam - the ConnectParam object

 example usage:
 
 ConnectParam connectParam = new ConnectParam.Builder()
                                             .withHost("localhost")
                                             .withPort(19530)
                                             .withConnectTimeout(10, TimeUnit.SECONDS)
                                             .withKeepAliveTime(Long.MAX_VALUE, TimeUnit.NANOSECONDS)
                                             .withKeepAliveTimeout(20, TimeUnit.SECONDS)
                                             .keepAliveWithoutCalls(false)
                                             .withIdleTimeout(24, TimeUnit.HOURS)
                                             .build();
 
 

Returns:

Response

Throws:

ConnectFailedException - if client failed to connect

See Also:

ConnectParam, Response, ConnectFailedException

isConnected

public boolean isConnected()

Specified by:

isConnected in interface MilvusClient

Returns:

true if the client is connected to Milvus server and the channel's connectivity state is READY.

disconnect

public Response disconnect()
                    throws InterruptedException

Description copied from interface: MilvusClient

Disconnects from Milvus server

Specified by:

disconnect in interface MilvusClient

Returns:

Response

Throws:

InterruptedException

See Also:

Response

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
                                           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
                               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

createPartition

public Response createPartition(String collectionName,
                                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

showPartitions

public ShowPartitionsResponse showPartitions(String collectionName)

Description copied from interface: MilvusClient

Shows current partitions of a collection

Specified by:

showPartitions in interface MilvusClient

Parameters:

collectionName - collection name

Returns:

ShowPartitionsResponse

See Also:

ShowPartitionsResponse, Response

dropPartition

public Response dropPartition(String collectionName,
                              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

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

searchInFiles

public SearchResponse searchInFiles(@Nonnull
                                    List<String> fileIds,
                                    @Nonnull
                                    SearchParam searchParam)

Description copied from interface: MilvusClient

Searches vectors in specific files

Specified by:

searchInFiles in interface MilvusClient

Parameters:

fileIds - list of file ids to search from

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

describeCollection

public DescribeCollectionResponse describeCollection(@Nonnull
                                                     String collectionName)

Description copied from interface: MilvusClient

Describes the collection

Specified by:

describeCollection in interface MilvusClient

Parameters:

collectionName - collection to describe

See Also:

DescribeCollectionResponse, CollectionMapping, Response

showCollections

public ShowCollectionsResponse showCollections()

Description copied from interface: MilvusClient

Shows current collections

Specified by:

showCollections in interface MilvusClient

Returns:

ShowCollectionsResponse

See Also:

ShowCollectionsResponse, Response

getCollectionRowCount

public GetCollectionRowCountResponse getCollectionRowCount(@Nonnull
                                                           String collectionName)

Description copied from interface: MilvusClient

Gets current row count of a collection

Specified by:

getCollectionRowCount in interface MilvusClient

Parameters:

collectionName - collection to get row count

Returns:

GetCollectionRowCountResponse

See Also:

GetCollectionRowCountResponse, 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
                        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

preloadCollection

public Response preloadCollection(@Nonnull
                                  String collectionName)

Description copied from interface: MilvusClient

Pre-loads collection to memory

Specified by:

preloadCollection in interface MilvusClient

Parameters:

collectionName - collection to preload

Returns:

Response

See Also:

Response

describeIndex

public DescribeIndexResponse describeIndex(@Nonnull
                                           String collectionName)

Description copied from interface: MilvusClient

Describes collection index

Specified by:

describeIndex in interface MilvusClient

Parameters:

collectionName - collection to describe index of

See Also:

DescribeIndexResponse, Index, Response

dropIndex

public Response dropIndex(@Nonnull
                          String collectionName)

Description copied from interface: MilvusClient

Drops collection index

Specified by:

dropIndex in interface MilvusClient

Parameters:

collectionName - collection to drop index of

See Also:

Response

showCollectionInfo

public ShowCollectionInfoResponse showCollectionInfo(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.

Specified by:

showCollectionInfo in interface MilvusClient

Parameters:

collectionName - collection to show info from

See Also:

ShowCollectionInfoResponse, CollectionInfo, CollectionInfo.PartitionInfo, CollectionInfo.PartitionInfo.SegmentInfo, Response

getVectorById

public GetVectorByIdResponse getVectorById(String collectionName,
                                           Long id)

Description copied from interface: MilvusClient

Gets either a float or binary vector by id.

Specified by:

getVectorById in interface MilvusClient

Parameters:

collectionName - collection to get vector from

id - vector id

See Also:

GetVectorByIdResponse, Response

getVectorIds

public GetVectorIdsResponse getVectorIds(String collectionName,
                                         String segmentName)

Description copied from interface: MilvusClient

Gets all vector ids in a segment

Specified by:

getVectorIds in interface MilvusClient

Parameters:

collectionName - collection to get vector ids from

segmentName - segment name

See Also:

GetVectorIdsResponse, Response

deleteByIds

public Response deleteByIds(String collectionName,
                            List<Long> ids)

Description copied from interface: MilvusClient

Deletes data in a collection by a list of ids

Specified by:

deleteByIds in interface MilvusClient

Parameters:

collectionName - collection to delete ids from

ids - a List of vector ids to delete

See Also:

Response

deleteById

public Response deleteById(String collectionName,
                           Long id)

Description copied from interface: MilvusClient

Deletes data in a collection by a single id

Specified by:

deleteById in interface MilvusClient

Parameters:

collectionName - collection to delete id from

id - vector id to delete

See Also:

Response

flush

public Response flush(List<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

See Also:

Response

flush

public Response flush(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

See Also:

Response

compact

public Response compact(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

See Also:

Response