Skip to main content

getPkField()

Addedv2.6.x

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

await milvusClient.getPkField(data: DescribeCollectionReq)

Request Syntax​

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

PARAMETERS:

  • collection_name (string) -

    [REQUIRED]

    The name of the collection.

  • timeout (number) -

    RPC timeout in milliseconds. Optional.

RETURNS:

Promise<FieldSchema>

The complete field schema object for the primary key, including name, data type, field ID, and other properties.

Example​

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

const client = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
const pkField = await client.getPkField({
    collection_name: 'my_collection',
});
console.log(pkField.name, pkField.data_type);