Package io.milvus.client

Interface MilvusClient

All Known Implementing Classes:

MilvusGrpcClient

public interface MilvusClient

The Milvus Client Interface

Field Summary

Fields

Modifier and Type	Field	Description
static String	clientVersion

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(TableSchema tableSchema)	Creates table specified by tableSchemaParam
DescribeIndexResponse	describeIndex(String tableName)	Describes table index
DescribeTableResponse	describeTable(String tableName)	Describes table
Response	disconnect()	Disconnects from Milvus server
Response	dropIndex(String tableName)	Drops table index
Response	dropTable(String tableName)	Drops table
default String	getClientVersion()
Response	getServerStatus()	Prints server status
Response	getServerVersion()	Prints server version
GetTableRowCountResponse	getTableRowCount(String tableName)	Gets current row count of table
HasTableResponse	hasTable(String tableName)	Check whether table exists
InsertResponse	insert(InsertParam insertParam)	Inserts data specified by insertParam
boolean	isConnected()
Response	preloadTable(String tableName)	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

Field Detail

clientVersion

static final String clientVersion

See Also:

Constant Field Values

Method Detail

getClientVersion

default String getClientVersion()

Returns:

the current Milvus client version

connect

Response connect(ConnectParam connectParam)
          throws ConnectFailedException

Connects to Milvus server

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

boolean isConnected()

Returns:

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

disconnect

Response disconnect()
             throws InterruptedException

Disconnects from Milvus server

Returns:

Response

Throws:

InterruptedException

See Also:

Response

createTable

Response createTable(TableSchema tableSchema)

Creates table specified by tableSchemaParam

Parameters:

tableSchema - the TableSchema object

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

Returns:

Response

See Also:

TableSchema, MetricType, Response

hasTable

HasTableResponse hasTable(String tableName)

Check whether table exists

Parameters:

tableName - table to check

Returns:

HasTableResponse

See Also:

HasTableResponse, Response

dropTable

Response dropTable(String tableName)

Drops table

Parameters:

tableName - table to drop

Returns:

Response

See Also:

Response

createIndex

Response createIndex(CreateIndexParam createIndexParam)

Creates index specified by indexParam

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)
                                                         .build();
 
 

Returns:

Response

See Also:

Index, CreateIndexParam, IndexType, Response

insert

InsertResponse insert(InsertParam insertParam)

Inserts data specified by insertParam

Parameters:

insertParam - the InsertParam object

 example usage:
 
 InsertParam insertParam = new InsertParam.Builder(tableName, vectors)
                                          .withVectorIds(vectorIds)
                                          .build();
 
 

Returns:

InsertResponse

See Also:

InsertParam, InsertResponse, Response

search

SearchResponse search(SearchParam searchParam)

Searches vectors specified by searchParam

Parameters:

searchParam - the SearchParam object

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

Returns:

SearchResponse

See Also:

SearchParam, DateRange, SearchResponse, SearchResponse.QueryResult, Response

searchInFiles

SearchResponse searchInFiles(SearchInFilesParam searchInFilesParam)

Searches vectors in specific files specified by searchInFilesParam

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)
                                                               .build();
 
 

Returns:

SearchResponse

See Also:

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

describeTable

DescribeTableResponse describeTable(String tableName)

Describes table

Parameters:

tableName - table to describe

See Also:

DescribeTableResponse, Response

showTables

ShowTablesResponse showTables()

Shows current tables

Returns:

ShowTablesResponse

See Also:

ShowTablesResponse, Response

getTableRowCount

GetTableRowCountResponse getTableRowCount(String tableName)

Gets current row count of table

Parameters:

tableName - table to count

Returns:

GetTableRowCountResponse

See Also:

GetTableRowCountResponse, Response

getServerStatus

Response getServerStatus()

Prints server status

Returns:

Response

See Also:

Response

getServerVersion

Response getServerVersion()

Prints server version

Returns:

Response

See Also:

Response

preloadTable

Response preloadTable(String tableName)

Pre-loads table to memory

Parameters:

tableName - table to preload

Returns:

Response

See Also:

Response

describeIndex

DescribeIndexResponse describeIndex(String tableName)

Describes table index

Parameters:

tableName - table to describe index of

See Also:

DescribeIndexResponse, Index, Response

dropIndex

Response dropIndex(String tableName)

Drops table index

Parameters:

tableName - table to drop index of

See Also:

Response