public interface MilvusClient
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
clientVersion |
Modifier and Type | Method and Description |
---|---|
default java.lang.String |
clientVersion() |
Response |
connect(ConnectParam connectParam)
Connects to Milvus server
|
boolean |
connected() |
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 |
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 |
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 |
Response |
serverStatus()
Prints server status
|
Response |
serverVersion()
Prints server version
|
ShowTablesResponse |
showTables()
Shows current tables
|
static final java.lang.String clientVersion
default java.lang.String clientVersion()
Response connect(ConnectParam connectParam)
connectParam
- the ConnectParam
object
example usage:
ConnectParam connectParam = new ConnectParam.Builder()
.withHost("localhost")
.withPort("19530")
.build();
Response
ConnectParam
,
Response
boolean connected()
true
if the client is connected to Milvus serverResponse disconnect() throws java.lang.InterruptedException
Response
java.lang.InterruptedException
Response
Response createTable(TableSchemaParam tableSchemaParam)
tableSchemaParam
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();
Response
TableSchema
,
TableSchemaParam
,
MetricType
,
Response
HasTableResponse hasTable(TableParam tableParam)
tableParam
existstableParam
- the TableParam
object
example usage:
TableParam tableParam = new TableParam.Builder(tableName)
.withTimeout(timeout)
.build();
HasTableResponse
TableParam
,
HasTableResponse
,
Response
Response dropTable(TableParam tableParam)
tableParam
tableParam
- the TableParam
object
example usage:
TableParam tableParam = new TableParam.Builder(tableName)
.withTimeout(timeout)
.build();
Response
TableParam
,
Response
Response createIndex(CreateIndexParam createIndexParam)
indexParam
createIndexParam
- the IndexParam
object
example usage:
Index index = new Index.Builder()
.withIndexType(IndexType.IVF_SQ8)
.withNList(16384)
.build();
IndexParam indexParam = new IndexParam.Builder(tableName)
.withIndex(index)
.withTimeout(timeout)
.build();
Response
Index
,
CreateIndexParam
,
IndexType
,
Response
InsertResponse insert(InsertParam insertParam)
insertParam
insertParam
- the InsertParam
object
example usage:
InsertParam insertParam = new InsertParam.Builder(tableName, vectors)
.withVectorIds(vectorIds)
.withTimeout(timeout)
.build();
InsertResponse
InsertParam
,
InsertResponse
,
Response
SearchResponse search(SearchParam searchParam)
searchParam
searchParam
- the SearchParam
object
example usage:
SearchParam searchParam = new SearchParam.Builder(tableName, vectorsToSearch)
.withTopK(topK)
.withNProbe(nProbe)
.withDateRanges(dateRanges)
.withTimeout(timeout)
.build();
SearchResponse
SearchParam
,
DateRange
,
SearchResponse
,
SearchResponse.QueryResult
,
Response
SearchResponse searchInFiles(SearchInFilesParam searchInFilesParam)
searchInFilesParam
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();
SearchResponse
SearchInFilesParam
,
SearchParam
,
DateRange
,
SearchResponse
,
SearchResponse.QueryResult
,
Response
DescribeTableResponse describeTable(TableParam tableParam)
tableParam
tableParam
- the TableParam
object
example usage:
TableParam tableParam = new TableParam.Builder(tableName)
.withTimeout(timeout)
.build();
DescribeTableResponse
TableParam
,
DescribeTableResponse
,
Response
ShowTablesResponse showTables()
ShowTablesResponse
ShowTablesResponse
,
Response
GetTableRowCountResponse getTableRowCount(TableParam tableParam)
tableParam
tableParam
- the TableParam
object
example usage:
TableParam tableParam = new TableParam.Builder(tableName)
.withTimeout(timeout)
.build();
GetTableRowCountResponse
GetTableRowCountResponse
,
Response
Response deleteByRange(DeleteByRangeParam deleteByRangeParam)
deleteByRangeParam
deleteByRangeParam
- the DeleteByRangeParam
object
example usage:
DeleteByRangeParam deleteByRangeParam = new DeleteByRangeParam.Builder(dateRange, tableName)
.withTimeout(timeout)
.build();
Response
DeleteByRangeParam
,
DateRange
,
Response
Response preloadTable(TableParam tableParam)
tableParam
- the TableParam
object
example usage:
TableParam tableParam = new TableParam.Builder(tableName)
.withTimeout(timeout)
.build();
Response
TableParam
,
Response
DescribeIndexResponse describeIndex(TableParam tableParam)
tableParam
tableParam
- the TableParam
object
example usage:
TableParam tableParam = new TableParam.Builder(tableName)
.withTimeout(timeout)
.build();
DescribeIndexResponse
TableParam
,
DescribeIndexResponse
,
Index
,
Response
Response dropIndex(TableParam tableParam)
tableParam
tableParam
- the TableParam
object
example usage:
TableParam tableParam = new TableParam.Builder(tableName)
.withTimeout(timeout)
.build();
dropIndex
TableParam
,
Response