メインコンテンツまでスキップ

count()

この操作は、指定されたフィルタリング式に一致するエンティティの数をカウントします。

javascript
await milvusClient.count(data)

Request Syntax

javascript
await milvusClient.count({
db_name?: string,
collection_name: string,
expr?: string,
timeout?: boolean
})

PARAMETERS:

  • db_name (str) -

    対象の collection を保持するデータベースの名前。

  • collection_name (str) -

    [REQUIRED]

    エイリアスを作成する collection の名前。

  • expr (string) -

    一致するエンティティを絞り込むための scalar フィルタリング条件。

    scalar フィルタリングをスキップするには、このパラメータを空文字列に設定できます。scalar フィルタリング条件の作成については、Boolean Expression Rules を参照してください。

  • timeout (number)

    この操作のタイムアウト時間。これを None に設定すると、レスポンスが返るかエラーが発生した時点でこの操作はタイムアウトします。

RETURNS Promise<CountResult>

このメソッドは、CountResult オブジェクトに解決される promise を返します。

typescript
{
data: number,
status: ResStatus
}

PARAMETERS:

  • data (number) -
    指定されたフィルタ式に一致する collection 内の行数。式が指定されていない場合、これは総行数です。

  • ResStatus
    ResStatus オブジェクト。

    • code (number) -

      操作結果を示すコード。この操作が成功した場合は 0 のままです。

    • error_code (string | number) -

      発生したエラーを示すエラーコード。この操作が成功した場合は Success のままです。

    • reason (string) -

      報告されたエラーの理由を示す理由。この操作が成功した場合は空文字列のままです。

Examples

javascript
const milvusClient = new MilvusClient({
address: 'YOUR_CLUSTER_ENDPOINT',
token: 'YOUR_CLUSTER_TOKEN',
});
const num_entities = await milvusClient.count({
collection_name: 'my_collection',
expr: "age in [1,2,3,4,5,6,7,8]",
});

// 1000
Ctrl I