统计Collection

本文介绍如何通过Java SDK获取已创建的Collection的统计信息,如Doc数等。

前提条件

接口定义

// class DashVectorClient

public Response<CollectionStats> stats();

使用示例

说明
  1. 需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT,代码才能正常运行。

  2. 本示例需要参考新建Collection-使用示例提前创建好名称为quickstart的Collection。

import com.aliyun.dashvector.DashVectorClient;
import com.aliyun.dashvector.DashVectorCollection;
import com.aliyun.dashvector.models.CollectionStats;
import com.aliyun.dashvector.common.DashVectorException;

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<CollectionStats> response = collection.stats();
        
      	System.out.println(response);
      	// example output:
        // {
        //     "code":0,
        //     "message":"Success",
        //     "requestId":"84b801f9-7545-4f9e-b480-713d6c4d9393",
        //     "output":{
        //         "totalDocCount":1,
        //         "indexCompleteness":1,
        //         "partitions":{
        //             "default":{
        //                 "totalDocCount":1
        //             }
        //         }
        //     }
        // }
    }
}

入参描述

出参描述

说明

返回结果为Response<CollectionStats>对象,Response<CollectionStats>对象中可获取本次操作结果信息,如下表所示。

方法

类型

描述

示例

getCode()

int

返回值,参考返回状态码说明

0

getMessage()

String

返回消息

success

getRequestId()

String

请求唯一id

19215409-ea66-4db9-8764-26ce2eb5bb99

getOutput()

CollectionStats

参考CollectionStats

{
  "totalDocCount":1,
  "indexCompleteness":1,
  "partitions":{
    "default":{
      "totalDocCount":1
    }
  }
}

isSuccess()

Boolean

判断请求是否成功

true