Java

MilvusClientV1Pool

A MilvusClientV1Pool instance is a connection pool for MilvusClient objects. The number of MilvusClient objects automatically increases or decreases to avoid frequent opening and closing connections, improving your application’s performance.

Methods of MilvusClient for connection:

Method	Description	Parameters	Returns
getClient(String key)	Get a client object that is idle from the pool.Once the caller holds the client, it will be marked as an active state and cannot be fetched by other callers.If the number of clients hits the MaxTotalPerKey value, this method will be blocked for MaxBlockWaitDuration.If no idle client is available after MaxBlockWaitDuration, this method will return a null object to the caller.	key: the key of a group where the client belongs	MilvusClient
returnClient(String key, MilvusClient grpcClient)	Return a client object. Once a client is returned, it becomes idle state and waits for the next caller.The caller should ensure the client is returned. Otherwise, the client will keep in active state and cannot be used by the next caller.Throw exceptions if the key doesn't exist or the client does not belong to this key group.	key: the key of a group where the client belongsgrpcClient: the client object to return	void
getIdleClientNumber(String key)	Return the number of idle clients of a key group.	key: the key of a group	int
getActiveClientNumber(String key)	Return the number of active clients of a key group.	key: the key of a group	int
getTotalIdleClientNumber()	Return the number of idle clients of all key groups.		int
getTotalActiveClientNumber()	Return the number of active clients of all key groups		int
clear(String key)	Release/disconnect idle clients of a key group.	key: the key of a group	void
clear()	Release/disconnect idle clients of all key groups.		void
close()	Release/disconnect all clients of all key groups, and close the pool.		void

PoolConfig

Use the PoolConfig.PoolConfigBuilder to construct a PoolConfig.

import io.milvus.pool.PoolConfig;
PoolConfig.PoolConfigBuilder builder = PoolConfig.builder();

Methods of PoolConfig.PoolConfigBuilder:

Method	Description	Patameters
maxIdlePerKey(int maxIdlePerKey)	The maximum number of idle clients for each key. If the number of idle clients exceeds this number, some clients will be automatically closed. The default value is 5.	maxIdlePerKey: The maximum number of idle clients .
minIdlePerKey(int minIdlePerKey)	The minimize number of idle clients for each key. The default value is 0.	minIdlePerKey: The minimize number of idle clients.
maxTotalPerKey(int maxTotalPerKey)	The maximum number of clients for each key, including idle clients and active clients. The default value is 10.	maxTotalPerKey: The maximum number of clients
maxTotal(int maxTotal)	The maximum number of clients in total, including idle clients and active clients. The default value is 50.	maxTotal: The maximum number of clients.
blockWhenExhausted(boolean blockWhenExhausted)	Block the getClient() method for a duration when the maximum number of clients is hit and all the clients are active. If this flag is false, the getClient() will instantly throw an exception if the maximum number of clients is hit and all the clients are active. The default value is true.	blockWhenExhausted: Set to true for blocking getClient() when the pool is full.
maxBlockWaitDuration(Duration maxBlockWaitDuration)	Max block duration when the maximum number of clients is hit and all the clients are active. The default value is 3 seconds.	maxBlockWaitDuration: Duration of blocking getClient().
evictionPollingInterval(Duration evictionPollingInterval)	Trigger an eviction action to evict expired idle clients for each duration. The default value is 60 seconds.	evictionPollingInterval: Interval to trigger eviction action.
minEvictableIdleDuration(Duration minEvictableIdleDuration)	An idle client expires after this duration and can be evicted.	minEvictableIdleDuration: Duration to evict idle client.
testOnBorrow(boolean testOnBorrow)	If this flag is set to true, the pool will check if the grpc connection of a client is terminated or closed each time the getClient() is called.	testOnBorrow: Set to true to check connection when getClient() is called.
testOnReturn(boolean testOnReturn)	If this flag is set to true, the pool will check if the grpc connection of a client is terminated or closed each time the returnClient() is called.	testOnReturn: Set to true to check connection when returnClient() is called.

Example

import io.milvus.param.ConnectParam
import io.milvus.pool.PoolConfig
import io.milvus.pool.MilvusClientV1Pool
import io.milvus.client.MilvusClient

ConnectParam connectConfig = ConnectParam.newBuilder()
        .withHost("localhost")
        .withPort(19530)
        .build();
PoolConfig poolConfig = PoolConfig.builder()
        .maxIdlePerKey(10) // max idle clients per key
        .maxTotalPerKey(20) // max total(idle + active) clients per key
        .maxTotal(100) // max total clients for all keys
        .maxBlockWaitDuration(Duration.ofSeconds(5L)) // getClient() will wait 5 seconds if no idle client available
        .minEvictableIdleDuration(Duration.ofSeconds(10L)) // if number of idle clients is larger than maxIdlePerKey, redundant idle clients will be evicted after 10 seconds
        .build();
MilvusClientV1Pool pool;

MilvusClient client = pool.getClient("client_name");
try {
    // use the client to do something
} catch (Exception e) {
} finally {
    pool.returnClient("client_name", client); // make sure the client is returned after use
}

Feedback

Was this page helpful?