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

Method Summary

Modifier and Type	Method	Description
Response	connect(ConnectParam connectParam)	Connects to Milvus server
Response	createIndex(CreateIndexParam createIndexParam)	Creates index specified by indexParam
Response	createTable(TableSchemaParam tableSchemaParam)	Creates table specified by tableSchemaParam
Response	deleteByRange(DeleteByRangeParam deleteByRangeParam)	Deletes vectors by date range, specified by deleteByRangeParam
DescribeIndexResponse	describeIndex(TableParam tableParam)	Describes table index specified by tableParam
DescribeTableResponse	describeTable(TableParam tableParam)	Describes table specified by tableParam
Response	disconnect()	Disconnects from Milvus server
Response	dropIndex(TableParam tableParam)	Drops table index specified by tableParam
Response	dropTable(TableParam tableParam)	Drops the table specified by tableParam
Response	getServerStatus()	Prints server status
Response	getServerVersion()	Prints server version
GetTableRowCountResponse	getTableRowCount(TableParam tableParam)	Gets current row count of table specified by tableParam
HasTableResponse	hasTable(TableParam tableParam)	Check whether the table specified by tableParam exists
InsertResponse	insert(InsertParam insertParam)	Inserts data specified by insertParam
boolean	isConnected()
Response	preloadTable(TableParam tableParam)	Pre-loads table to memory
SearchResponse	search(SearchParam searchParam)	Searches vectors specified by searchParam
SearchResponse	searchInFiles(SearchInFilesParam searchInFilesParam)	Searches vectors in specific files specified by searchInFilesParam
ShowTablesResponse	showTables()	Shows current tables

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

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")
                                             .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

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

createTable

public Response createTable(@Nonnull
                            TableSchemaParam tableSchemaParam)

Description copied from interface: MilvusClient

Creates table specified by tableSchemaParam

Specified by:

createTable in interface MilvusClient

Parameters:

tableSchemaParam - the TableSchemaParam object

 example usage:
 
 TableSchema tableSchema = new TableSchema.Builder(tableName, dimension)
                                          .withIndexFileSize(1024)
                                          .withMetricType(MetricType.IP)
                                          .build();
 TableSchemaParam tableSchemaParam = new TableSchemaParam.Builder(tableSchema)
                                                         .withTimeout(timeout)
                                                         .build();
 
 

Returns:

Response

See Also:

TableSchema, TableSchemaParam, MetricType, Response

hasTable

public HasTableResponse hasTable(@Nonnull
                                 TableParam tableParam)

Description copied from interface: MilvusClient

Check whether the table specified by tableParam exists

Specified by:

hasTable in interface MilvusClient

Parameters:

tableParam - the TableParam object

 example usage:
 
 TableParam tableParam = new TableParam.Builder(tableName)
                                       .withTimeout(timeout)
                                       .build();
 
 

Returns:

HasTableResponse

See Also:

TableParam, HasTableResponse, Response

dropTable

public Response dropTable(@Nonnull
                          TableParam tableParam)

Description copied from interface: MilvusClient

Drops the table specified by tableParam

Specified by:

dropTable in interface MilvusClient

Parameters:

tableParam - the TableParam object

 example usage:
 
 TableParam tableParam = new TableParam.Builder(tableName)
                                       .withTimeout(timeout)
                                       .build();
 
 

Returns:

Response

See Also:

TableParam, Response

createIndex

public Response createIndex(@Nonnull
                            CreateIndexParam createIndexParam)

Description copied from interface: MilvusClient

Creates index specified by indexParam

Specified by:

createIndex in interface MilvusClient

Parameters:

createIndexParam - the CreateIndexParam object

 example usage:
 
 Index index = new Index.Builder()
                        .withIndexType(IndexType.IVF_SQ8)
                        .withNList(16384)
                        .build();
 CreateIndexParam createIndexParam = new CreateIndexParam.Builder(tableName)
                                                         .withIndex(index)
                                                         .withTimeout(timeout)
                                                         .build();
 
 

Returns:

Response

See Also:

Index, CreateIndexParam, IndexType, 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(tableName, vectors)
                                          .withVectorIds(vectorIds)
                                          .withTimeout(timeout)
                                          .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(tableName, vectorsToSearch)
                                          .withTopK(topK)
                                          .withNProbe(nProbe)
                                          .withDateRanges(dateRanges)
                                          .withTimeout(timeout)
                                          .build();
 
 

Returns:

SearchResponse

See Also:

SearchParam, DateRange, SearchResponse, SearchResponse.QueryResult, Response

searchInFiles

public SearchResponse searchInFiles(@Nonnull
                                    SearchInFilesParam searchInFilesParam)

Description copied from interface: MilvusClient

Searches vectors in specific files specified by searchInFilesParam

Specified by:

searchInFiles in interface MilvusClient

Parameters:

searchInFilesParam - the SearchInFilesParam object

 example usage:
 
 SearchParam searchParam = new SearchParam.Builder(tableName, vectorsToSearch)
                                          .withTopK(topK)
                                          .withNProbe(nProbe)
                                          .withDateRanges(dateRanges)
                                          .build();
 SearchInFilesParam searchInFilesParam = new SearchInFilesParam.Builder(fileIds, searchParam)
                                                               .withTimeout(timeout)
                                                               .build();
 
 

Returns:

SearchResponse

See Also:

SearchInFilesParam, SearchParam, DateRange, SearchResponse, SearchResponse.QueryResult, Response

describeTable

public DescribeTableResponse describeTable(@Nonnull
                                           TableParam tableParam)

Description copied from interface: MilvusClient

Describes table specified by tableParam

Specified by:

describeTable in interface MilvusClient

Parameters:

tableParam - the TableParam object

 example usage:
 
 TableParam tableParam = new TableParam.Builder(tableName)
                                       .withTimeout(timeout)
                                       .build();
 
 

Returns:

DescribeTableResponse

See Also:

TableParam, DescribeTableResponse, Response

showTables

public ShowTablesResponse showTables()

Description copied from interface: MilvusClient

Shows current tables

Specified by:

showTables in interface MilvusClient

Returns:

ShowTablesResponse

See Also:

ShowTablesResponse, Response

getTableRowCount

public GetTableRowCountResponse getTableRowCount(@Nonnull
                                                 TableParam tableParam)

Description copied from interface: MilvusClient

Gets current row count of table specified by tableParam

Specified by:

getTableRowCount in interface MilvusClient

Parameters:

tableParam - the TableParam object

 example usage:
 
 TableParam tableParam = new TableParam.Builder(tableName)
                                       .withTimeout(timeout)
                                       .build();
 
 

Returns:

GetTableRowCountResponse

See Also:

GetTableRowCountResponse, Response

getServerStatus

public Response getServerStatus()

Description copied from interface: MilvusClient

Prints server status

Specified by:

getServerStatus in interface MilvusClient

Returns:

Response

See Also:

Response

getServerVersion

public Response getServerVersion()

Description copied from interface: MilvusClient

Prints server version

Specified by:

getServerVersion in interface MilvusClient

Returns:

Response

See Also:

Response

deleteByRange

public Response deleteByRange(@Nonnull
                              DeleteByRangeParam deleteByRangeParam)

Description copied from interface: MilvusClient

Deletes vectors by date range, specified by deleteByRangeParam

Specified by:

deleteByRange in interface MilvusClient

Parameters:

deleteByRangeParam - the DeleteByRangeParam object

 example usage:
 
 DeleteByRangeParam deleteByRangeParam = new DeleteByRangeParam.Builder(dateRange, tableName)
                                                               .withTimeout(timeout)
                                                               .build();
 
 

Returns:

Response

See Also:

DeleteByRangeParam, DateRange, Response

preloadTable

public Response preloadTable(@Nonnull
                             TableParam tableParam)

Description copied from interface: MilvusClient

Pre-loads table to memory

Specified by:

preloadTable in interface MilvusClient

Parameters:

tableParam - the TableParam object

 example usage:
 
 TableParam tableParam = new TableParam.Builder(tableName)
                                       .withTimeout(timeout)
                                       .build();
 
 

Returns:

Response

See Also:

TableParam, Response

describeIndex

public DescribeIndexResponse describeIndex(@Nonnull
                                           TableParam tableParam)

Description copied from interface: MilvusClient

Describes table index specified by tableParam

Specified by:

describeIndex in interface MilvusClient

Parameters:

tableParam - the TableParam object

 example usage:
 
 TableParam tableParam = new TableParam.Builder(tableName)
                                       .withTimeout(timeout)
                                       .build();
 
 

Returns:

DescribeIndexResponse

See Also:

TableParam, DescribeIndexResponse, Index, Response

dropIndex

public Response dropIndex(@Nonnull
                          TableParam tableParam)

Description copied from interface: MilvusClient

Drops table index specified by tableParam

Specified by:

dropIndex in interface MilvusClient

Parameters:

tableParam - the TableParam object

 example usage:
 
 TableParam tableParam = new TableParam.Builder(tableName)
                                       .withTimeout(timeout)
                                       .build();
 
 

Returns:

dropIndex

See Also:

TableParam, Response