getCollectionStatistics()

Addedv2.3.xModifiedv3.0.x

This operation lists the statistics collected on a specific collection.

await milvusClient.getCollectionStatistics(data)

Request Syntax

await milvusClient.getCollectionStatistics({ 
    db_name: string,
    collection_name: string,
    timeout?: number 
})

PARAMETERS:

• db_name (string) -

  The name of the database that holds the target collection.

• collection_name (string) -

  [REQUIRED]

  The name of a collection.

• timeout (number) -

  The timeout duration for this operation.

  Setting this to None indicates that this operation timeouts when any response returns or error occurs.

RETURNS Promise<StatisticsResponse>

This method returns a promise that resolves to a StatisticsResponse object.

{
    stats: KeyValuePair[],
    data: { [x: string]: any },
    status:  ResStatus
}

PARAMETERS:

• stats (KeyValuePair[]) - The raw statistics list returned by Milvus. Each entry has a key (for example, row_count) and a value as a string.

• data (Record<string, any>) - A flattened, key-indexed view of stats for convenience. For example, data.row_count returns the row count as a string.

• ResStatus A ResStatus object.

  • code (number) -

    A code that indicates the operation result. It remains 0 if this operation succeeds.

  • error_code (string | number) -

    An error code that indicates an occurred error. It remains Success if this operation succeeds.

  • reason (string) -

    The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.

Example

const milvusClient = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
 const res = await milvusClient.getCollectionStatistics({ collection_name: 'my_collection' });