Java SDK统计Partition实战指南
在向量检索的实际应用中,经常需要核对某个 Partition 内的文档数量,以此评估数据规模或确认写入操作是否完成。本文演示如何通过 Java SDK 获取已有 Partition 的统计信息,例如文档计数。流程简洁直白,无冗余步骤。
前提条件
- 已创建 Cluster:参考创建 Cluster 指南。
- 已获取 API‑KEY:参见 API‑KEY 管理文档。
- 已安装最新版 SDK:请参照 DashVector SDK 安装说明。
接口定义
先查看接口签名。在 DashVectorCollection 类中,只需调用 statsPartition 方法,并传入 Partition 名称即可。
// class DashVectorCollection
public Response statsPartition(String name);
使用示例
说明
- 请将示例中的
YOUR_API_KEY替换为你自己的 API‑KEY,将YOUR_CLUSTER_ENDPOINT替换为你的 Cluster Endpoint,否则代码无法运行。 - 本示例假定你已按照“新建 Collection”指引提前创建了名为
quickstart的 Collection。 - 同时,请确保已按照“新建 Partition”指引提前创建了名为
shoes的 Partition。
以下是一段完整的 Java 代码,演示如何获取 Partition 统计信息并输出结果:
import com.aliyun.dashvector.DashVectorClient;
import com.aliyun.dashvector.DashVectorCollection;
import com.aliyun.dashvector.common.DashVectorException;
import com.aliyun.dashvector.models.PartitionStats;
import com.aliyun.dashvector.models.responses.Response;
import ja va.util.List;
public class Main {
public static void main(String[] args) throws DashVectorException {
DashVectorClient client = new DashVectorClient("YOUR_API_KEY", "YOUR_CLUSTER_ENDPOINT");
DashVectorCollection collection = client.get("quickstart");
Response response = collection.statsPartition("shoes");
System.out.println(response);
// example output:
// {"code":0,"message":"Success","requestId":"ebb83c4a-35f7-4128-b1ad-d8e3d9be49a2","output":{"totalDocCount":0}}
}
}
入参描述
仅一个参数,结构清晰:
| 参数 | 类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| name | String | 是 | - | Partition 名称 |
出参描述
说明
返回值为 Response 对象,内置多个方法可直接获取所需信息。具体如下:
| 方法 | 类型 | 描述 | 示例 |
|---|---|---|---|
| getCode() | int | 返回状态码,参考返回状态码说明 | 0 |
| getMessage() | String | 返回消息 | success |
| getRequestId() | String | 请求唯一标识 | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
| getOutput() | PartitionStats | 参考 PartitionStats 定义 | {"totalDocCount":0} |
| isSuccess() | Boolean | 判断请求是否成功 | true |
最核心的是 getOutput(),从中可获取 totalDocCount,即当前 Partition 的文档总数。配合 isSuccess() 可先确认请求是否成功,从而完成一次完整的统计查询。整个过程仅需一行调用,无隐性陷阱。
