Get collection statistics

Prerequisites

Before you begin, make sure that you have:

• A DashVector cluster

• An API key

• The DashVector SDK (latest version)

API definition

// DashVectorClient
public Response<CollectionStats> stats();

This method takes no request parameters and returns a Response<CollectionStats> object containing the collection-level statistics.

Example

The following example retrieves statistics for a collection named quickstart. Before running the code, replace the placeholders with your actual values.

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 {
        // Initialize the client with your API key and cluster endpoint
        DashVectorClient client = new DashVectorClient("YOUR_API_KEY", "YOUR_CLUSTER_ENDPOINT");

        // Get a handle to the target collection
        DashVectorCollection collection = client.get("quickstart");

        // Retrieve collection statistics
        Response<CollectionStats> response = collection.stats();

        System.out.println(response);
    }
}

Sample output:

{
    "code": 0,
    "message": "Success",
    "requestId": "84b801f9-7545-4f9e-b480-713d6c4d9393",
    "output": {
        "totalDocCount": 1,
        "indexCompleteness": 1,
        "partitions": {
            "default": {
                "totalDocCount": 1
            }
        }
    }
}

Response parameters

The stats() method returns a Response<CollectionStats> object.