新建 Client

最近更新时间:2025-07-01 10:19:42

我的收藏

功能介绍

RPCVectorDBClient() 用于通过 RPC(Remote Procedure Call,远程过程调用)的请求方式创建一个向量数据库的客户端对象。
VectorDBClient() 为了兼容旧版本而保留,用于通过 HTTP I/O 请求方式创建一个向量数据库的客户端对象。
说明:
Java SDK 为1.3.5及以上版本支持 RPC(Remote Procedure Call,远程过程调用)通信,在多线程场景,RPC 可以提供比 HTTP I/O 更好的并发请求能力。
RPCVectorDBClient() 支持创建连接池,特别适合客户端节点较少但 collection 副本较多(尤其是单 Shard 多副本)的场景。
RPCVectorDBClient()
VectorDBClient()
public RPCVectorDBClient(ConnectParam connectParam, ReadConsistencyEnum readConsistency)
public VectorDBClient(ConnectParam connectParam, ReadConsistencyEnum readConsistency)

使用示例

RPC 请求(推荐)
HTTP IO 请求(兼容 Restful 旧版本 )
import com.tencent.tcvectordb.client.VectorDBClient;
import com.tencent.tcvectordb.model.*;


public class VectorDBExample {
public static void main(String[] args) {
// 创建VectorDB Client
ConnectParam connectParam = ConnectParam.newBuilder()
.withUrl("http://10.0.X.X:80")
.withUsername("root")
.withKey("eC4bLRy2va******************************")
.withTimeout(30)
.build();
VectorDBClient client = new RPCVectorDBClient(connectParam,ReadConsistencyEnum.EVENTUAL_CONSISTENCY);
}
}
import com.tencent.tcvectordb.client.VectorDBClient;
import com.tencent.tcvectordb.model.*;

public class VectorDBExample {
public static void main(String[] args) {
// 创建VectorDB Client
ConnectParam connectParam = ConnectParam.newBuilder()
.withUrl("http://10.0.X.X:80")
.withUsername("root")
.withKey("eC4bLRy2va******************************")
.withTimeout(30)
.withConnectTimeout(5)
.withMaxIdleConnections(10)
.withKeepAliveDuration(5 * 60)
.build();
VectorDBClient client = new VectorDBClient(connectParam,ReadConsistencyEnum.EVENTUAL_CONSISTENCY);
}
}

入参描述

参数
子参数
参数含义
是否必选
获取方式
connectParam
Url
客户端所需连接的向量数据库服务端访问地址。
获取向量数据库实例内网 IP 地址与端口,请登录 向量数据库控制台,在实例详情页面网络信息区域直接复制访问地址。具体操作,请参见 查看实例信息



Username
客户端访问向量数据库服务端的账号。
数据库当前仅支持 root 账号。
Key
客户端访问向量数据库服务端的 API 密钥,用于进行身份认证。
请登录 向量数据库控制台,在密钥管理页面直接复制密钥。具体操作,请参见 密钥管理

Timeout
请求超时时间。
单位:秒。
取值范围:大于等于0。
默认值:10。
connectTimeout
指建立新连接时的超时时间。
单位:秒。
默认值:10。
取值范围:大于0。
maxIdleConnections
指最大空闲连接数。
RPC 默认值:1。
HTTP 默认为 10。
正整数,建议设置为数据节点个数的2-5倍。
keepAliveDuration
设置空闲连接的超时时间。
单位:秒
取值范围:大于0。
默认值:300。
readConsistency
-
设置读一致性。
取值如下所示,默认为 EVENTUAL_CONSISTENCY
ReadConsistencyEnum.STRONG_CONSISTENCY:强一致性。
ReadConsistencyEnum.EVENTUAL_CONSISTENCY:最终一致性。

输出说明

说明:
如果抛出异常,说明连接数据库异常。具体异常原因,可根据提示信息进行分析。无任何提示信息说明执行成功。