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

delete()

この操作は、ID またはブール式を使用してエンティティを削除します。

javascript
await milvusClient.delete(data)

リクエスト構文​

このメソッドには以下の選択肢があります。

DeleteByIdsReq を使用​

javascript
await milvusClient.delete({
   db_name: string,
   collection_name: string,
   partition_name?: string,
   ids: string[] | number[],
   consistency_level: string,
   timeout?: number
 })

パラメータ:

  • db_name (string) -

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

  • collection_name (string) -

    [必須]

    既存の collection の名前。

  • partition_name (string) -

    collection 内の既存の partition の名前。

  • ids (string[] | number[]) -

    [必須]

    特定のエンティティ ID、またはエンティティ ID のリスト。

    デフォルト値は None で、scalar フィルタリング条件が適用されることを示します。

  • consistency_level (ConsistencyLevelEnum) -

    対象 collection の整合性レベル。デフォルト値は Bounded (1) で、Strong (0)、Bounded (1)、Session (2)、Eventually (3) を選択できます。

  • timeout (number) -

    この操作のタイムアウト時間。

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

戻り値 Promise<MutationResult>

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

typescript
{
    succ_index: number[],
    err_index: number[],
    acknowledged: boolean,
    insert_cnt: string,
    delete_cnt: string,
    upsert_cnt: string,
    timestamp: string,
    IDs: { int_id?: { data: number[] }, str_id?: { data: string[] }, id_field: 'int_id' | 'str_id' },
    status:  ResStatus
}

パラメータ:

  • succ_index (number[]) -
    行に一致し、削除済みとしてマークされた入力 ID の 0 ベース位置。

  • err_index (number[]) -
    どの行にも一致しなかった入力 ID の 0 ベース位置。

  • acknowledged (boolean) -
    削除が Milvus によって確認されたかどうか。

  • insert_cnt (string) -
    delete() では常に "0" です。

  • delete_cnt (string) -
    この操作によって論理削除された行数。

  • upsert_cnt (string) -
    delete() では常に "0" です。

  • timestamp (string) -
    削除が可視化されたハイブリッドタイムスタンプ。

  • IDs (StringArrayId | NumberArrayId) -
    この削除の対象となった主キー。完全なフィールドリファレンスについては、insert() のドキュメントを参照してください。

  • ResStatus
    ResStatus オブジェクト。

    • code (number) -

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

    • error_code (string | number) -

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

    • reason (string) -

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

例​

python
const milvusClient = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
 const resStatus = await milvusClient.delete({
   collection_name: 'my_collection',
   ids: [1,2,3,4]
 });
Ctrl I