getPkFieldName()

この操作は、コレクションの主キーフィールド名を取得します。これは、コレクションの情報を取得し、主キーフィールド名を抽出する便利なメソッドです。

javascript
await milvusClient.getPkFieldName(data: DescribeCollectionReq)

リクエスト構文

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

パラメータ:

collection_name (string) -

[必須]

コレクション名。
timeout (number) -

ミリ秒単位の RPC タイムアウト。省略可能です。

戻り値:

Promise<string>

主キーフィールドの名前。

例

javascript
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"

リクエスト構文​

例​

リクエスト構文

例