Skip to main content

getPkFieldName()

Addedv2.6.x

This operation gets the primary key field name of a collection. This is a convenient method that describes the collection and extracts the primary key field name.

await milvusClient.getPkFieldName(data: DescribeCollectionReq)

Request Syntax​

getPkFieldName({
    collection_name: string,
    timeout: number
})

PARAMETERS:

  • collection_name (string) -

    [REQUIRED]

    The name of the collection.

  • timeout (number) -

    RPC timeout in milliseconds. Optional.

RETURNS:

Promise<string>

The name of the primary key field.

Example​

import { MilvusClient } from '@zilliz/milvus2-sdk-node';

const client = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
const pkName = await client.getPkFieldName({
    collection_name: 'my_collection',
});
console.log(pkName); // e.g., "id"