java.lang.Object

io.milvus.client.AbstractMilvusGrpcClient

io.milvus.client.MilvusServiceClient

All Implemented Interfaces:: MilvusClient

public class MilvusServiceClient extends AbstractMilvusGrpcClient

Field Summary

Fields inherited from class io.milvus.client.AbstractMilvusGrpcClient
logger, logLevel
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

MilvusServiceClient(MilvusServiceClient src)

MilvusServiceClient(@NonNull ConnectParam connectParam)
Method Summary

Modifier and Type

Method

Description

R<RpcStatus>

addUserToRole(AddUserToRoleParam requestParam)

The user will get permissions that the role are allowed to perform operations.

R<RpcStatus>

alterAlias(AlterAliasParam requestParam)

Alters alias from a collection to another.

R<RpcStatus>

alterCollection(AlterCollectionParam requestParam)

Alter collection with key-value properties.

R<RpcStatus>

alterDatabase(AlterDatabaseParam requestParam)

Alter database with key value pair.

protected MilvusServiceGrpc.MilvusServiceBlockingStub

blockingStub()

R<ImportResponse>

bulkInsert(BulkInsertParam requestParam)

Import data from external files, currently support JSON format

R<CheckHealthResponse>

checkHealth()

Check server health

boolean

clientIsReady()

void

close(long maxWaitSeconds)

Disconnects from a Milvus server with configurable timeout.

R<RpcStatus>

createAlias(CreateAliasParam requestParam)

Creates an alias for a collection.

R<RpcStatus>

createCollection(CreateCollectionParam requestParam)

Creates a collection in Milvus.

R<RpcStatus>

createCollection(CreateSimpleCollectionParam requestParam)

Creates a collection in Milvus.

R<RpcStatus>

createCredential(CreateCredentialParam requestParam)

Create credential using the given user and password.

R<RpcStatus>

createDatabase(CreateDatabaseParam requestParam)

Creates a database in Milvus.

R<RpcStatus>

createIndex(CreateIndexParam requestParam)

Creates an index on a vector field in the specified collection.

R<RpcStatus>

createPartition(CreatePartitionParam requestParam)

Creates a partition in the specified collection.

R<RpcStatus>

createResourceGroup(CreateResourceGroupParam requestParam)

Create a resource group.

R<RpcStatus>

createRole(CreateRoleParam requestParam)

It will success if the role isn't existed, otherwise fail.

R<MutationResult>

delete(DeleteParam requestParam)

Deletes entity(s) based on primary key(s) filtered by boolean expression.

R<DeleteResponse>

delete(DeleteIdsParam requestParam)

Deletes entity(s) based on the value of primary key.

R<RpcStatus>

deleteCredential(DeleteCredentialParam requestParam)

Delete credential corresponding to the user.

R<DescribeCollectionResponse>

describeCollection(DescribeCollectionParam requestParam)

Shows the details of a collection, e.g.

R<DescribeDatabaseResponse>

describeDatabase(DescribeDatabaseParam requestParam)

Show detail of database base, such as replica number and resource groups.

R<DescribeIndexResponse>

describeIndex(DescribeIndexParam requestParam)

Shows the information of the specified index.

R<DescribeResourceGroupResponse>

describeResourceGroup(DescribeResourceGroupParam requestParam)

Describe a resource group.

R<RpcStatus>

dropAlias(DropAliasParam requestParam)

Drops an alias for the specified collection.

R<RpcStatus>

dropCollection(DropCollectionParam requestParam)

Drops a collection.

R<RpcStatus>

dropDatabase(DropDatabaseParam requestParam)

Drops a database.

R<RpcStatus>

dropIndex(DropIndexParam requestParam)

Drops the index on a vector field in the specified collection.

R<RpcStatus>

dropPartition(DropPartitionParam requestParam)

Drops a partition.

R<RpcStatus>

dropResourceGroup(DropResourceGroupParam requestParam)

Drop a resource group.

R<RpcStatus>

dropRole(DropRoleParam requestParam)

It will success if the role is existed, otherwise fail.

R<FlushResponse>

flush(FlushParam requestParam)

Flush insert buffer into storage.

R<FlushAllResponse>

flushAll(boolean syncFlushAll, long syncFlushAllWaitingInterval, long syncFlushAllTimeout)

Flush all collections.

protected MilvusServiceGrpc.MilvusServiceFutureStub

futureStub()

R<GetResponse>

get(GetIdsParam requestParam)

Get entity(s) based on the value of primary key.

R<GetImportStateResponse>

getBulkInsertState(GetBulkInsertStateParam requestParam)

Get state of bulk insert task

R<GetCollectionStatisticsResponse>

getCollectionStatistics(GetCollectionStatisticsParam requestParam)

Shows the statistics information of a collection.

R<GetCompactionStateResponse>

getCompactionState(GetCompactionStateParam requestParam)

Gets the compaction state by id.

R<GetCompactionPlansResponse>

getCompactionStateWithPlans(GetCompactionPlansParam requestParam)

Gets compaction state with its plan.

R<GetFlushAllStateResponse>

getFlushAllState(GetFlushAllStateParam requestParam)

Get flush state of all segments.

R<GetFlushStateResponse>

getFlushState(GetFlushStateParam requestParam)

Get flush state of specified collection.

R<GetIndexBuildProgressResponse>

getIndexBuildProgress(@NonNull GetIndexBuildProgressParam requestParam)

Shows the index building progress, such as how many rows are indexed.

R<GetIndexStateResponse>

getIndexState(@NonNull GetIndexStateParam requestParam)

Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).

R<GetLoadingProgressResponse>

getLoadingProgress(GetLoadingProgressParam requestParam)

Get collection loading progress

R<GetLoadStateResponse>

getLoadState(GetLoadStateParam requestParam)

Get collection loading state

R<GetMetricsResponse>

getMetrics(GetMetricsParam requestParam)

Gets the runtime metrics information of Milvus, returns the result in .json format.

R<GetPartitionStatisticsResponse>

getPartitionStatistics(GetPartitionStatisticsParam requestParam)

Shows the statistics information of a partition.

R<GetPersistentSegmentInfoResponse>

getPersistentSegmentInfo(GetPersistentSegmentInfoParam requestParam)

Gets the information of persistent segments from data node, including row count, persistence state(growing or flushed), etc.

R<GetQuerySegmentInfoResponse>

getQuerySegmentInfo(GetQuerySegmentInfoParam requestParam)

Gets the query information of segments in a collection from query node, including row count, memory usage size, index name, etc.

R<GetReplicasResponse>

getReplicas(GetReplicasParam requestParam)

Returns the collection's replica information

R<GetVersionResponse>

getVersion()

Get server version

R<RpcStatus>

grantRolePrivilege(GrantRolePrivilegeParam requestParam)

Grant Role Privilege.

R<Boolean>

hasCollection(HasCollectionParam requestParam)

Checks if a collection exists.

R<Boolean>

hasPartition(HasPartitionParam requestParam)

Checks if a partition exists in the specified collection.

R<SearchResults>

hybridSearch(HybridSearchParam requestParam)

Conducts multi vector similarity search with a ranker for rearrangement.

R<MutationResult>

insert(InsertParam requestParam)

Inserts entities into a specified collection .

R<InsertResponse>

insert(InsertRowsParam requestParam)

Inserts rows data into a specified collection .

R<ListAliasesResponse>

listAliases(ListAliasesParam requestParam)

List all alias for a collection.

R<ListImportTasksResponse>

listBulkInsertTasks(ListBulkInsertTasksParam requestParam)

List bulk insert tasks

R<ListCollectionsResponse>

listCollections(ListCollectionsParam requestParam)

Lists all collections

R<ListCredUsersResponse>

listCredUsers(ListCredUsersParam requestParam)

List all user names.

R<ListDatabasesResponse>

listDatabases()

List databases.

R<ListResourceGroupsResponse>

listResourceGroups(ListResourceGroupsParam requestParam)

List resource groups.

R<RpcStatus>

loadBalance(LoadBalanceParam requestParam)

Moves segment from a query node to another to keep the load balanced.

R<RpcStatus>

loadCollection(LoadCollectionParam requestParam)

Loads a collection to memory before search or query.

R<RpcStatus>

loadPartitions(LoadPartitionsParam requestParam)

Loads a partition into memory.

R<ManualCompactionResponse>

manualCompact(ManualCompactParam requestParam)

Performs a manual compaction.

R<QueryResults>

query(QueryParam requestParam)

Queries entity(s) based on scalar field(s) filtered by boolean expression.

R<QueryResponse>

query(QuerySimpleParam requestParam)

Queries entity(s) based on scalar field(s) filtered by boolean expression.

R<QueryIterator>

queryIterator(QueryIteratorParam requestParam)

Get queryIterator based on scalar field(s) filtered by boolean expression.

R<RpcStatus>

releaseCollection(ReleaseCollectionParam requestParam)

Releases a collection from memory to reduce memory usage.

R<RpcStatus>

releasePartitions(ReleasePartitionsParam requestParam)

Releases a partition from memory.

R<RpcStatus>

removeUserFromRole(RemoveUserFromRoleParam requestParam)

The user will remove permissions that the role are allowed to perform operations.

R<RpcStatus>

renameCollection(RenameCollectionParam requestParam)

rename a collection

R<RpcStatus>

revokeRolePrivilege(RevokeRolePrivilegeParam requestParam)

Revoke Role Privilege.

R<SearchResults>

search(SearchParam requestParam)

Conducts ANN search on a vector field.

R<SearchResponse>

search(SearchSimpleParam requestParam)

Conducts ANN search on a vector field.

R<SearchIterator>

searchIterator(SearchIteratorParam requestParam)

Get searchIterator based on a vector field.

R<SelectGrantResponse>

selectGrantForRole(SelectGrantForRoleParam requestParam)

List a grant info for the role and the specific object

R<SelectGrantResponse>

selectGrantForRoleAndObject(SelectGrantForRoleAndObjectParam requestParam)

List a grant info for the role

R<SelectRoleResponse>

selectRole(SelectRoleParam requestParam)

Get all users who are added to the role.

R<SelectUserResponse>

selectUser(SelectUserParam requestParam)

Get all roles the user has.

void

setLogLevel(LogLevel level)

Set log level in runtime.

R<ShowCollectionsResponse>

showCollections(ShowCollectionsParam requestParam)

Lists all collections or gets collection loading status.

R<ShowPartitionsResponse>

showPartitions(ShowPartitionsParam requestParam)

Shows all partitions in the specified collection.

R<RpcStatus>

transferNode(TransferNodeParam requestParam)

Transfer a query node from source resource group to target resource_group.

R<RpcStatus>

transferReplica(TransferReplicaParam requestParam)

Transfer a replica from source resource group to target resource_group.

R<RpcStatus>

updateCredential(UpdateCredentialParam requestParam)

Update credential using the given user and password.

R<RpcStatus>

updateResourceGroups(UpdateResourceGroupsParam requestParam)

Update resource groups.

R<MutationResult>

upsert(UpsertParam requestParam)

Insert new entities into a specified collection, replace them if the entities already exist.

MilvusClient

withRetry(int retryTimes)

Number of retry attempts.

MilvusClient

withRetry(RetryParam retryParam)

Sets the parameters for retry.

MilvusClient

withRetryInterval(long interval, TimeUnit timeUnit)

Time interval between retry attempts.

MilvusClient

withTimeout(long timeout, TimeUnit timeoutUnit)

Timeout setting for rpc call.

Methods inherited from class io.milvus.client.AbstractMilvusGrpcClient
alterIndex, hybridSearchAsync, insertAsync, logDebug, logError, logInfo, logWarning, queryAsync, searchAsync, upsertAsync

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

Constructor Details
- MilvusServiceClient
  
  public MilvusServiceClient(@NonNull @NonNull ConnectParam connectParam)
- MilvusServiceClient
  
  protected MilvusServiceClient(MilvusServiceClient src)
Method Details
- blockingStub
  
  protected MilvusServiceGrpc.MilvusServiceBlockingStub blockingStub()
  
  Specified by:
  
  blockingStub in class AbstractMilvusGrpcClient
- futureStub
  
  protected MilvusServiceGrpc.MilvusServiceFutureStub futureStub()
  
  Specified by:
  
  futureStub in class AbstractMilvusGrpcClient
- clientIsReady
  
  public boolean clientIsReady()
  
  Specified by:
  
  clientIsReady in class AbstractMilvusGrpcClient
- close
  
  public void close(long maxWaitSeconds) throws InterruptedException
  
  Description copied from interface: MilvusClient
  
  Disconnects from a Milvus server with configurable timeout.
  
  Parameters:
  
  maxWaitSeconds - timeout unit: second
  
  Throws:
  
  InterruptedException - throw InterruptedException if the client failed to close connection
- withTimeout
  
  public MilvusClient withTimeout(long timeout, TimeUnit timeoutUnit)
  
  Description copied from interface: MilvusClient
  
  Timeout setting for rpc call.
  
  Parameters:
  
  timeout - set time waiting for a rpc call.
  
  timeoutUnit - time unit
  
  Returns:
  
  MilvusClient
- withRetry
  
  public MilvusClient withRetry(RetryParam retryParam)
  
  Description copied from interface: MilvusClient
  
  Sets the parameters for retry.
  
  Parameters:
  
  retryParam - RetryParam
  
  Returns:
  
  MilvusClient
- withRetry
  
  public MilvusClient withRetry(int retryTimes)
  
  Description copied from interface: MilvusClient
  
  Number of retry attempts.
  
  Parameters:
  
  retryTimes - number of retry attempts.
  
  Returns:
  
  MilvusClient
- withRetryInterval
  
  public MilvusClient withRetryInterval(long interval, TimeUnit timeUnit)
  
  Description copied from interface: MilvusClient
  
  Time interval between retry attempts. Default value is 500ms.
  
  Parameters:
  
  interval - time interval between retry attempts.
  
  timeUnit - time unit
  
  Returns:
  
  MilvusClient
- setLogLevel
  
  public void setLogLevel(LogLevel level)
  
  Description copied from interface: MilvusClient
  
  Set log level in runtime.
  
  Parameters:
  
  level - LogLevel
- hasCollection
  
  public R<Boolean> hasCollection(HasCollectionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Checks if a collection exists.
  
  Specified by:
  
  hasCollection in interface MilvusClient
  
  Overrides:
  
  hasCollection in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - HasCollectionParam
  
  Returns:
  
  {status:result code, data: boolean, whether if has collection or not}
- createDatabase
  
  public R<RpcStatus> createDatabase(CreateDatabaseParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Creates a database in Milvus.
  
  Specified by:
  
  createDatabase in interface MilvusClient
  
  Overrides:
  
  createDatabase in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - CreateDatabaseParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- dropDatabase
  
  public R<RpcStatus> dropDatabase(DropDatabaseParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Drops a database. Note that this method drops all data in the database.
  
  Specified by:
  
  dropDatabase in interface MilvusClient
  
  Overrides:
  
  dropDatabase in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DropDatabaseParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- listDatabases
  
  public R<ListDatabasesResponse> listDatabases()
  
  Description copied from interface: MilvusClient
  
  List databases. Note that this method list all database in the cluster.
  
  Specified by:
  
  listDatabases in interface MilvusClient
  
  Overrides:
  
  listDatabases in class AbstractMilvusGrpcClient
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- alterDatabase
  
  public R<RpcStatus> alterDatabase(AlterDatabaseParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Alter database with key value pair. (Available from Milvus v2.4.4)
  
  Specified by:
  
  alterDatabase in interface MilvusClient
  
  Overrides:
  
  alterDatabase in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - AlterDatabaseParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- describeDatabase
  
  public R<DescribeDatabaseResponse> describeDatabase(DescribeDatabaseParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Show detail of database base, such as replica number and resource groups. (Available from Milvus v2.4.4)
  
  Specified by:
  
  describeDatabase in interface MilvusClient
  
  Overrides:
  
  describeDatabase in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DescribeDatabaseParam
  
  Returns:
  
  {status:result code, data:DescribeDatabaseResponse{replica_number,resource_groups}}
- createCollection
  
  public R<RpcStatus> createCollection(CreateCollectionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Creates a collection in Milvus.
  
  Specified by:
  
  createCollection in interface MilvusClient
  
  Overrides:
  
  createCollection in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - CreateCollectionParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- dropCollection
  
  public R<RpcStatus> dropCollection(DropCollectionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Drops a collection. Note that this method drops all data in the collection.
  
  Specified by:
  
  dropCollection in interface MilvusClient
  
  Overrides:
  
  dropCollection in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DropCollectionParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- loadCollection
  
  public R<RpcStatus> loadCollection(LoadCollectionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Loads a collection to memory before search or query.
  
  Specified by:
  
  loadCollection in interface MilvusClient
  
  Overrides:
  
  loadCollection in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - LoadCollectionParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- releaseCollection
  
  public R<RpcStatus> releaseCollection(ReleaseCollectionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Releases a collection from memory to reduce memory usage. Note that you cannot search while the corresponding collection is released from memory.
  
  Specified by:
  
  releaseCollection in interface MilvusClient
  
  Overrides:
  
  releaseCollection in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - ReleaseCollectionParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- describeCollection
  
  public R<DescribeCollectionResponse> describeCollection(DescribeCollectionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Shows the details of a collection, e.g. name, schema.
  
  Specified by:
  
  describeCollection in interface MilvusClient
  
  Overrides:
  
  describeCollection in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DescribeCollectionParam
  
  Returns:
  
  {status:result code, data:DescribeCollectionResponse{schema,collectionID}}
- getCollectionStatistics
  
  public R<GetCollectionStatisticsResponse> getCollectionStatistics(GetCollectionStatisticsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Shows the statistics information of a collection.
  
  Specified by:
  
  getCollectionStatistics in interface MilvusClient
  
  Overrides:
  
  getCollectionStatistics in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetCollectionStatisticsParam
  
  Returns:
  
  {status:result code, data: GetCollectionStatisticsResponse{status,stats}}
- renameCollection
  
  public R<RpcStatus> renameCollection(RenameCollectionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  rename a collection
  
  Specified by:
  
  renameCollection in interface MilvusClient
  
  Overrides:
  
  renameCollection in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - RenameCollectionParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- showCollections
  
  public R<ShowCollectionsResponse> showCollections(ShowCollectionsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Lists all collections or gets collection loading status.
  
  Specified by:
  
  showCollections in interface MilvusClient
  
  Overrides:
  
  showCollections in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - ShowCollectionsParam
  
  Returns:
  
  {status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}
- alterCollection
  
  public R<RpcStatus> alterCollection(AlterCollectionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Alter collection with key-value properties.
  
  Specified by:
  
  alterCollection in interface MilvusClient
  
  Overrides:
  
  alterCollection in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - AlterCollectionParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- flush
  
  public R<FlushResponse> flush(FlushParam requestParam)
  
  Description copied from class: AbstractMilvusGrpcClient
  
  Flush insert buffer into storage. To make sure the buffer persisted successfully, it calls GetFlushState() to check related segments state.
  
  Specified by:
  
  flush in interface MilvusClient
  
  Overrides:
  
  flush in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - FlushParam
  
  Returns:
  
  {status:result code,data: FlushResponse{flush segment ids}}
- flushAll
  
  public R<FlushAllResponse> flushAll(boolean syncFlushAll, long syncFlushAllWaitingInterval, long syncFlushAllTimeout)
  
  Description copied from class: AbstractMilvusGrpcClient
  
  Flush all collections. All insertions, deletions, and upserts before `flushAll` will be synced.
  
  Specified by:
  
  flushAll in interface MilvusClient
  
  Overrides:
  
  flushAll in class AbstractMilvusGrpcClient
  
  Parameters:
  
  syncFlushAll - {flushAll synchronously or asynchronously}
  
  syncFlushAllWaitingInterval - {wait intervel when flushAll synchronously}
  
  syncFlushAllTimeout - {timeout when flushAll synchronously}
  
  Returns:
  
  {status:result code,data: FlushAllResponse{flushAllTs}}
- createPartition
  
  public R<RpcStatus> createPartition(CreatePartitionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Creates a partition in the specified collection.
  
  Specified by:
  
  createPartition in interface MilvusClient
  
  Overrides:
  
  createPartition in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - CreatePartitionParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- dropPartition
  
  public R<RpcStatus> dropPartition(DropPartitionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Drops a partition. Note that this method drops all data in this partition and the _default partition cannot be dropped.
  
  Specified by:
  
  dropPartition in interface MilvusClient
  
  Overrides:
  
  dropPartition in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DropPartitionParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- hasPartition
  
  public R<Boolean> hasPartition(HasPartitionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Checks if a partition exists in the specified collection.
  
  Specified by:
  
  hasPartition in interface MilvusClient
  
  Overrides:
  
  hasPartition in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - HasPartitionParam
  
  Returns:
  
  {status:result code, data: boolean, whether if has collection or not}
- loadPartitions
  
  public R<RpcStatus> loadPartitions(LoadPartitionsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Loads a partition into memory.
  
  Specified by:
  
  loadPartitions in interface MilvusClient
  
  Overrides:
  
  loadPartitions in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - LoadPartitionsParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- releasePartitions
  
  public R<RpcStatus> releasePartitions(ReleasePartitionsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Releases a partition from memory.
  
  Specified by:
  
  releasePartitions in interface MilvusClient
  
  Overrides:
  
  releasePartitions in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - ReleasePartitionsParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- getPartitionStatistics
  
  public R<GetPartitionStatisticsResponse> getPartitionStatistics(GetPartitionStatisticsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Shows the statistics information of a partition.
  
  Specified by:
  
  getPartitionStatistics in interface MilvusClient
  
  Overrides:
  
  getPartitionStatistics in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetPartitionStatisticsParam
  
  Returns:
  
  {status:result code,data:GetPartitionStatisticsResponse{status,stats}}
- showPartitions
  
  public R<ShowPartitionsResponse> showPartitions(ShowPartitionsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Shows all partitions in the specified collection.
  
  Specified by:
  
  showPartitions in interface MilvusClient
  
  Overrides:
  
  showPartitions in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - ShowPartitionsParam
  
  Returns:
  
  {status:result code, data:ShowPartitionsResponse{partition_names,partitionIDs,created_timestamps,created_utc_timestamps}}
- createAlias
  
  public R<RpcStatus> createAlias(CreateAliasParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Creates an alias for a collection. Alias can be used in search or query to replace the collection name
  
  Specified by:
  
  createAlias in interface MilvusClient
  
  Overrides:
  
  createAlias in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - CreateAliasParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- dropAlias
  
  public R<RpcStatus> dropAlias(DropAliasParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Drops an alias for the specified collection.
  
  Specified by:
  
  dropAlias in interface MilvusClient
  
  Overrides:
  
  dropAlias in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DropAliasParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- alterAlias
  
  public R<RpcStatus> alterAlias(AlterAliasParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Alters alias from a collection to another.
  
  Specified by:
  
  alterAlias in interface MilvusClient
  
  Overrides:
  
  alterAlias in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - AlterAliasParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- listAliases
  
  public R<ListAliasesResponse> listAliases(ListAliasesParam requestParam)
  
  Description copied from interface: MilvusClient
  
  List all alias for a collection.
  
  Specified by:
  
  listAliases in interface MilvusClient
  
  Overrides:
  
  listAliases in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - ListAliasesParam
  
  Returns:
  
  {status:result code, data:ListAliasesResponse{status, aliases}}
- createIndex
  
  public R<RpcStatus> createIndex(CreateIndexParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Creates an index on a vector field in the specified collection. Note that index building is an async progress.
  
  Specified by:
  
  createIndex in interface MilvusClient
  
  Overrides:
  
  createIndex in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - CreateIndexParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- dropIndex
  
  public R<RpcStatus> dropIndex(DropIndexParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Drops the index on a vector field in the specified collection.
  
  Specified by:
  
  dropIndex in interface MilvusClient
  
  Overrides:
  
  dropIndex in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DropIndexParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- describeIndex
  
  public R<DescribeIndexResponse> describeIndex(DescribeIndexParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Shows the information of the specified index. Current release of Milvus only supports showing latest built index.
  
  Specified by:
  
  describeIndex in interface MilvusClient
  
  Overrides:
  
  describeIndex in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DescribeIndexParam
  
  Returns:
  
  {status:result code, data:DescribeIndexResponse{status,index_descriptions}}
- getIndexState
  
  public R<GetIndexStateResponse> getIndexState(@NonNull @NonNull GetIndexStateParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).
  
  Specified by:
  
  getIndexState in interface MilvusClient
  
  Overrides:
  
  getIndexState in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetIndexStateParam
  
  Returns:
  
  {status:result code, data:GetIndexStateResponse{status,state}}
- getIndexBuildProgress
  
  public R<GetIndexBuildProgressResponse> getIndexBuildProgress(@NonNull @NonNull GetIndexBuildProgressParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Shows the index building progress, such as how many rows are indexed.
  
  Specified by:
  
  getIndexBuildProgress in interface MilvusClient
  
  Overrides:
  
  getIndexBuildProgress in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetIndexBuildProgressParam
  
  Returns:
  
  {status:result code, data:GetIndexBuildProgressResponse{status,indexed_rows}}
- insert
  
  public R<MutationResult> insert(InsertParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Inserts entities into a specified collection . Note that you don't need to input primary key field if auto_id is enabled.
  
  Specified by:
  
  insert in interface MilvusClient
  
  Overrides:
  
  insert in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - InsertParam
  
  Returns:
  
  {status:result code, data: MutationResult{insert results}}
- upsert
  
  public R<MutationResult> upsert(UpsertParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Insert new entities into a specified collection, replace them if the entities already exist.
  
  Specified by:
  
  upsert in interface MilvusClient
  
  Overrides:
  
  upsert in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - UpsertParam
  
  Returns:
  
  {status:result code, data: MutationResult{insert results}}
- delete
  
  public R<MutationResult> delete(DeleteParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Deletes entity(s) based on primary key(s) filtered by boolean expression. Current release of Milvus only supports expression in the format "pk_field in [1, 2, ...]"
  
  Specified by:
  
  delete in interface MilvusClient
  
  Overrides:
  
  delete in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DeleteParam
  
  Returns:
  
  {status:result code, data: MutationResult{delete results}}
- search
  
  public R<SearchResults> search(SearchParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Conducts ANN search on a vector field. Use expression to do filtering before search.
  
  Specified by:
  
  search in interface MilvusClient
  
  Overrides:
  
  search in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - SearchParam
  
  Returns:
  
  {status:result code, data: SearchResults{topK results}}
- hybridSearch
  
  public R<SearchResults> hybridSearch(HybridSearchParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Conducts multi vector similarity search with a ranker for rearrangement.
  
  Specified by:
  
  hybridSearch in interface MilvusClient
  
  Overrides:
  
  hybridSearch in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - HybridSearchParam
  
  Returns:
  
  {status:result code, data: SearchResults{topK results}}
- query
  
  public R<QueryResults> query(QueryParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Queries entity(s) based on scalar field(s) filtered by boolean expression. Note that the order of the returned entities cannot be guaranteed.
  
  Specified by:
  
  query in interface MilvusClient
  
  Overrides:
  
  query in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - QueryParam
  
  Returns:
  
  {status:result code,data: QueryResults{filter results}}
- getMetrics
  
  public R<GetMetricsResponse> getMetrics(GetMetricsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Gets the runtime metrics information of Milvus, returns the result in .json format.
  
  Specified by:
  
  getMetrics in interface MilvusClient
  
  Overrides:
  
  getMetrics in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetMetricsParam
  
  Returns:
  
  {status:result code, data:GetMetricsResponse{status,metrics}}
- getFlushState
  
  public R<GetFlushStateResponse> getFlushState(GetFlushStateParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Get flush state of specified collection.
  
  Specified by:
  
  getFlushState in interface MilvusClient
  
  Overrides:
  
  getFlushState in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetFlushStateParam
  
  Returns:
  
  {status:result code, data:GetMetricsResponse{status,metrics}}
- getFlushAllState
  
  public R<GetFlushAllStateResponse> getFlushAllState(GetFlushAllStateParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Get flush state of all segments.
  
  Specified by:
  
  getFlushAllState in interface MilvusClient
  
  Overrides:
  
  getFlushAllState in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetFlushAllStateParam
  
  Returns:
  
  {status:result code, data:GetMetricsResponse{status,metrics}}
- getPersistentSegmentInfo
  
  public R<GetPersistentSegmentInfoResponse> getPersistentSegmentInfo(GetPersistentSegmentInfoParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Gets the information of persistent segments from data node, including row count, persistence state(growing or flushed), etc.
  
  Specified by:
  
  getPersistentSegmentInfo in interface MilvusClient
  
  Overrides:
  
  getPersistentSegmentInfo in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetPersistentSegmentInfoParam
  
  Returns:
  
  {status:result code, data:GetPersistentSegmentInfoResponse{status,info}}
- getQuerySegmentInfo
  
  public R<GetQuerySegmentInfoResponse> getQuerySegmentInfo(GetQuerySegmentInfoParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Gets the query information of segments in a collection from query node, including row count, memory usage size, index name, etc.
  
  Specified by:
  
  getQuerySegmentInfo in interface MilvusClient
  
  Overrides:
  
  getQuerySegmentInfo in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetQuerySegmentInfoParam
  
  Returns:
  
  {status:result code, data:GetQuerySegmentInfoResponse{status,info}}
- getReplicas
  
  public R<GetReplicasResponse> getReplicas(GetReplicasParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Returns the collection's replica information
  
  Specified by:
  
  getReplicas in interface MilvusClient
  
  Overrides:
  
  getReplicas in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetReplicasParam
  
  Returns:
  
  {status:result code, data:GetReplicasResponse{status,info}}
- loadBalance
  
  public R<RpcStatus> loadBalance(LoadBalanceParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Moves segment from a query node to another to keep the load balanced.
  
  Specified by:
  
  loadBalance in interface MilvusClient
  
  Overrides:
  
  loadBalance in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - LoadBalanceParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- getCompactionState
  
  public R<GetCompactionStateResponse> getCompactionState(GetCompactionStateParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Gets the compaction state by id.
  
  Specified by:
  
  getCompactionState in interface MilvusClient
  
  Overrides:
  
  getCompactionState in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetCompactionStateParam
  
  Returns:
  
  {status:result code, data:GetCompactionStateResponse{status,info}}
- manualCompact
  
  public R<ManualCompactionResponse> manualCompact(ManualCompactParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Performs a manual compaction.
  
  Specified by:
  
  manualCompact in interface MilvusClient
  
  Overrides:
  
  manualCompact in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - ManualCompactParam
  
  Returns:
  
  {status:result code, data:ManualCompactionResponse{status,info}}
- getCompactionStateWithPlans
  
  public R<GetCompactionPlansResponse> getCompactionStateWithPlans(GetCompactionPlansParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Gets compaction state with its plan.
  
  Specified by:
  
  getCompactionStateWithPlans in interface MilvusClient
  
  Overrides:
  
  getCompactionStateWithPlans in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetCompactionPlansParam
  
  Returns:
  
  {status:result code, data:GetCompactionPlansResponse{status,info}}
- createCredential
  
  public R<RpcStatus> createCredential(CreateCredentialParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Create credential using the given user and password.
  
  Specified by:
  
  createCredential in interface MilvusClient
  
  Overrides:
  
  createCredential in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - CreateCredentialParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- updateCredential
  
  public R<RpcStatus> updateCredential(UpdateCredentialParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Update credential using the given user and password. You must provide the original password to check if the operation is valid. Note: after this operation, client won't change the related header of this connection. So if you update credential for this connection, the connection may be invalid.
  
  Specified by:
  
  updateCredential in interface MilvusClient
  
  Overrides:
  
  updateCredential in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - UpdateCredentialParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- deleteCredential
  
  public R<RpcStatus> deleteCredential(DeleteCredentialParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Delete credential corresponding to the user.
  
  Specified by:
  
  deleteCredential in interface MilvusClient
  
  Overrides:
  
  deleteCredential in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DeleteCredentialParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- listCredUsers
  
  public R<ListCredUsersResponse> listCredUsers(ListCredUsersParam requestParam)
  
  Description copied from interface: MilvusClient
  
  List all user names.
  
  Specified by:
  
  listCredUsers in interface MilvusClient
  
  Overrides:
  
  listCredUsers in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - ListCredUsersParam
  
  Returns:
  
  {status:result code, data:ListCredUsersResponse{status,info}}
- createRole
  
  public R<RpcStatus> createRole(CreateRoleParam requestParam)
  
  Description copied from interface: MilvusClient
  
  It will success if the role isn't existed, otherwise fail.
  
  Specified by:
  
  createRole in interface MilvusClient
  
  Overrides:
  
  createRole in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - CreateRoleParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- dropRole
  
  public R<RpcStatus> dropRole(DropRoleParam requestParam)
  
  Description copied from interface: MilvusClient
  
  It will success if the role is existed, otherwise fail.
  
  Specified by:
  
  dropRole in interface MilvusClient
  
  Overrides:
  
  dropRole in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DropRoleParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- addUserToRole
  
  public R<RpcStatus> addUserToRole(AddUserToRoleParam requestParam)
  
  Description copied from interface: MilvusClient
  
  The user will get permissions that the role are allowed to perform operations.
  
  Specified by:
  
  addUserToRole in interface MilvusClient
  
  Overrides:
  
  addUserToRole in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - AddUserToRoleParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- removeUserFromRole
  
  public R<RpcStatus> removeUserFromRole(RemoveUserFromRoleParam requestParam)
  
  Description copied from interface: MilvusClient
  
  The user will remove permissions that the role are allowed to perform operations.
  
  Specified by:
  
  removeUserFromRole in interface MilvusClient
  
  Overrides:
  
  removeUserFromRole in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - AddUserToRoleParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- selectRole
  
  public R<SelectRoleResponse> selectRole(SelectRoleParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Get all users who are added to the role.
  
  Specified by:
  
  selectRole in interface MilvusClient
  
  Overrides:
  
  selectRole in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - SelectRoleParam
  
  Returns:
  
  {status:result code, data:SelectRoleResponse{status,info}}
- selectUser
  
  public R<SelectUserResponse> selectUser(SelectUserParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Get all roles the user has.
  
  Specified by:
  
  selectUser in interface MilvusClient
  
  Overrides:
  
  selectUser in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - SelectUserParam
  
  Returns:
  
  {status:result code, data:SelectUserResponse{status,info}}
- grantRolePrivilege
  
  public R<RpcStatus> grantRolePrivilege(GrantRolePrivilegeParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Grant Role Privilege.
  
  Specified by:
  
  grantRolePrivilege in interface MilvusClient
  
  Overrides:
  
  grantRolePrivilege in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GrantRolePrivilegeParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- revokeRolePrivilege
  
  public R<RpcStatus> revokeRolePrivilege(RevokeRolePrivilegeParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Revoke Role Privilege.
  
  Specified by:
  
  revokeRolePrivilege in interface MilvusClient
  
  Overrides:
  
  revokeRolePrivilege in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - RevokeRolePrivilegeParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- selectGrantForRole
  
  public R<SelectGrantResponse> selectGrantForRole(SelectGrantForRoleParam requestParam)
  
  Description copied from interface: MilvusClient
  
  List a grant info for the role and the specific object
  
  Specified by:
  
  selectGrantForRole in interface MilvusClient
  
  Overrides:
  
  selectGrantForRole in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - SelectGrantForRoleParam
  
  Returns:
  
  {status:result code, data:SelectRoleResponse{status,info}}
- selectGrantForRoleAndObject
  
  public R<SelectGrantResponse> selectGrantForRoleAndObject(SelectGrantForRoleAndObjectParam requestParam)
  
  Description copied from interface: MilvusClient
  
  List a grant info for the role
  
  Specified by:
  
  selectGrantForRoleAndObject in interface MilvusClient
  
  Overrides:
  
  selectGrantForRoleAndObject in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - SelectGrantForRoleAndObjectParam
  
  Returns:
  
  {status:result code, data:SelectRoleResponse{status,info}}
- bulkInsert
  
  public R<ImportResponse> bulkInsert(BulkInsertParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Import data from external files, currently support JSON format
  
  Specified by:
  
  bulkInsert in interface MilvusClient
  
  Overrides:
  
  bulkInsert in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - BulkInsertParam
  
  Returns:
  
  {status:result code, data:ImportResponse{status,info}}
- getBulkInsertState
  
  public R<GetImportStateResponse> getBulkInsertState(GetBulkInsertStateParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Get state of bulk insert task
  
  Specified by:
  
  getBulkInsertState in interface MilvusClient
  
  Overrides:
  
  getBulkInsertState in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetBulkInsertStateParam
  
  Returns:
  
  {status:result code, data:GetImportStateResponse{status,info}}
- listBulkInsertTasks
  
  public R<ListImportTasksResponse> listBulkInsertTasks(ListBulkInsertTasksParam requestParam)
  
  Description copied from interface: MilvusClient
  
  List bulk insert tasks
  
  Specified by:
  
  listBulkInsertTasks in interface MilvusClient
  
  Overrides:
  
  listBulkInsertTasks in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - ListBulkInsertTasksParam
  
  Returns:
  
  {status:result code, data:ListImportTasksResponse{status,info}}
- checkHealth
  
  public R<CheckHealthResponse> checkHealth()
  
  Description copied from interface: MilvusClient
  
  Check server health
  
  Specified by:
  
  checkHealth in interface MilvusClient
  
  Overrides:
  
  checkHealth in class AbstractMilvusGrpcClient
  
  Returns:
  
  {status:result code, data:CheckHealthResponse{status,info}}
- getVersion
  
  public R<GetVersionResponse> getVersion()
  
  Description copied from interface: MilvusClient
  
  Get server version
  
  Specified by:
  
  getVersion in interface MilvusClient
  
  Overrides:
  
  getVersion in class AbstractMilvusGrpcClient
  
  Returns:
  
  {status:result code, data:GetVersionResponse{status,info}}
- getLoadingProgress
  
  public R<GetLoadingProgressResponse> getLoadingProgress(GetLoadingProgressParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Get collection loading progress
  
  Specified by:
  
  getLoadingProgress in interface MilvusClient
  
  Overrides:
  
  getLoadingProgress in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetLoadingProgressParam
  
  Returns:
  
  {status:result code, data:GetLoadingProgressResponse{status}}
- getLoadState
  
  public R<GetLoadStateResponse> getLoadState(GetLoadStateParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Get collection loading state
  
  Specified by:
  
  getLoadState in interface MilvusClient
  
  Overrides:
  
  getLoadState in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetLoadStateParam
  
  Returns:
  
  {status:result code, data:GetLoadStateResponse{status}}
- createResourceGroup
  
  public R<RpcStatus> createResourceGroup(CreateResourceGroupParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Create a resource group.
  
  Specified by:
  
  createResourceGroup in interface MilvusClient
  
  Overrides:
  
  createResourceGroup in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - CreateResourceGroupParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- dropResourceGroup
  
  public R<RpcStatus> dropResourceGroup(DropResourceGroupParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Drop a resource group.
  
  Specified by:
  
  dropResourceGroup in interface MilvusClient
  
  Overrides:
  
  dropResourceGroup in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DropResourceGroupParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- listResourceGroups
  
  public R<ListResourceGroupsResponse> listResourceGroups(ListResourceGroupsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  List resource groups.
  
  Specified by:
  
  listResourceGroups in interface MilvusClient
  
  Overrides:
  
  listResourceGroups in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - ListResourceGroupsParam
  
  Returns:
  
  {status:result code, data:ListResourceGroupsResponse{status}}
- describeResourceGroup
  
  public R<DescribeResourceGroupResponse> describeResourceGroup(DescribeResourceGroupParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Describe a resource group.
  
  Specified by:
  
  describeResourceGroup in interface MilvusClient
  
  Overrides:
  
  describeResourceGroup in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DescribeResourceGroupParam
  
  Returns:
  
  {status:result code, data:DescribeResourceGroupResponse{status}}
- transferNode
  
  public R<RpcStatus> transferNode(TransferNodeParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Transfer a query node from source resource group to target resource_group.
  
  Specified by:
  
  transferNode in interface MilvusClient
  
  Overrides:
  
  transferNode in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - TransferNodeParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- transferReplica
  
  public R<RpcStatus> transferReplica(TransferReplicaParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Transfer a replica from source resource group to target resource_group.
  
  Specified by:
  
  transferReplica in interface MilvusClient
  
  Overrides:
  
  transferReplica in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - TransferReplicaParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- updateResourceGroups
  
  public R<RpcStatus> updateResourceGroups(UpdateResourceGroupsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Update resource groups.
  
  Specified by:
  
  updateResourceGroups in interface MilvusClient
  
  Overrides:
  
  updateResourceGroups in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - UpdateResourceGroupsParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- createCollection
  
  public R<RpcStatus> createCollection(CreateSimpleCollectionParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Creates a collection in Milvus.
  
  Specified by:
  
  createCollection in interface MilvusClient
  
  Overrides:
  
  createCollection in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - CreateSimpleCollectionParam
  
  Returns:
  
  {status:result code, data:RpcStatus{msg: result message}}
- listCollections
  
  public R<ListCollectionsResponse> listCollections(ListCollectionsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Lists all collections
  
  Specified by:
  
  listCollections in interface MilvusClient
  
  Overrides:
  
  listCollections in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - ListCollectionsParam
  
  Returns:
  
  {status:result code, data: ListCollectionsResponse{collection_names}}
- insert
  
  public R<InsertResponse> insert(InsertRowsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Inserts rows data into a specified collection . Note that you don't need to input primary key field if auto_id is enabled.
  
  Specified by:
  
  insert in interface MilvusClient
  
  Overrides:
  
  insert in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - InsertRowsParam
  
  Returns:
  
  {status:result code, data: MutationResult{insert results}}
- delete
  
  public R<DeleteResponse> delete(DeleteIdsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Deletes entity(s) based on the value of primary key.
  
  Specified by:
  
  delete in interface MilvusClient
  
  Overrides:
  
  delete in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - DeleteIdsParam
  
  Returns:
  
  {status:result code, data: MutationResult{delete results}}
- get
  
  public R<GetResponse> get(GetIdsParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Get entity(s) based on the value of primary key.
  
  Specified by:
  
  get in interface MilvusClient
  
  Overrides:
  
  get in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - GetIdsParam
  
  Returns:
  
  {status:result code, data: QueryResults{query results}}
- query
  
  public R<QueryResponse> query(QuerySimpleParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Queries entity(s) based on scalar field(s) filtered by boolean expression. Note that the order of the returned entities cannot be guaranteed.
  
  Specified by:
  
  query in interface MilvusClient
  
  Overrides:
  
  query in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - QuerySimpleParam
  
  Returns:
  
  {status:result code,data: QueryResults{filter results}}
- search
  
  public R<SearchResponse> search(SearchSimpleParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Conducts ANN search on a vector field. Use expression to do filtering before search.
  
  Specified by:
  
  search in interface MilvusClient
  
  Overrides:
  
  search in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - SearchSimpleParam
  
  Returns:
  
  {status:result code, data: SearchResults{topK results}}
- queryIterator
  
  public R<QueryIterator> queryIterator(QueryIteratorParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Get queryIterator based on scalar field(s) filtered by boolean expression. Note that the order of the returned entities cannot be guaranteed.
  
  Specified by:
  
  queryIterator in interface MilvusClient
  
  Overrides:
  
  queryIterator in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - QueryIteratorParam
  
  Returns:
  
  {status:result code,data: QueryIterator}
- searchIterator
  
  public R<SearchIterator> searchIterator(SearchIteratorParam requestParam)
  
  Description copied from interface: MilvusClient
  
  Get searchIterator based on a vector field. Use expression to do filtering before search.
  
  Specified by:
  
  searchIterator in interface MilvusClient
  
  Overrides:
  
  searchIterator in class AbstractMilvusGrpcClient
  
  Parameters:
  
  requestParam - SearchIteratorParam
  
  Returns:
  
  {status:result code, data: SearchIterator}

Class MilvusServiceClient

Field Summary

Fields inherited from class io.milvus.client.AbstractMilvusGrpcClient

Constructor Summary

Method Summary

Methods inherited from class io.milvus.client.AbstractMilvusGrpcClient

Methods inherited from class java.lang.Object

Methods inherited from interface io.milvus.client.MilvusClient

Constructor Details

MilvusServiceClient

MilvusServiceClient

Method Details

blockingStub

futureStub

clientIsReady

close

withTimeout

withRetry

withRetry

withRetryInterval

setLogLevel

hasCollection

createDatabase

dropDatabase

listDatabases

alterDatabase

describeDatabase

createCollection

dropCollection

loadCollection

releaseCollection

describeCollection

getCollectionStatistics

renameCollection

showCollections

alterCollection

flush

flushAll

createPartition

dropPartition

hasPartition

loadPartitions

releasePartitions

getPartitionStatistics

showPartitions

createAlias

dropAlias

alterAlias

listAliases

createIndex

dropIndex

describeIndex

getIndexState

getIndexBuildProgress

insert

upsert

delete

search

hybridSearch

query

getMetrics

getFlushState

getFlushAllState

getPersistentSegmentInfo

getQuerySegmentInfo

getReplicas

loadBalance

getCompactionState

manualCompact

getCompactionStateWithPlans

createCredential

updateCredential

deleteCredential

listCredUsers

createRole

dropRole

addUserToRole

removeUserFromRole

selectRole

selectUser