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

delete()

Addedv2.3.xModifiedv3.0.x

This operation deletes entities by their IDs or with a boolean expression.

await milvusClient.delete(data)

Request Syntax

This method has the following alternatives.

With DeleteByIdsReq

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

PARAMETERS:

  • db_name (string) -

    The name of the database that holds the target collection.

  • collection_name (string) -

    [REQUIRED]

    The name of an existing collection.

  • partition_name (string) -

    The name of an existing partition in the collection.

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

    [REQUIRED]

    A specific entity ID or a list of entity IDs.

    The value defaults to None, indicating that a scalar filtering condition applies.

  • consistency_level (ConsistencyLevelEnum) -

    The consistency level of the target collection. The value defaults to Bounded (1) with options of Strong (0), Bounded (1), Session (2), and Eventually (3).

  • timeout (number) -

    The timeout duration for this operation.

    Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.

RETURNS Promise<MutationResult>

This method returns a promise that resolves to a MutationResult object.

{
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
}

PARAMETERS:

  • succ_index (number[]) - The zero-based positions of input IDs that matched a row and were marked deleted.

  • err_index (number[]) - The zero-based positions of input IDs that did not match any row.

  • acknowledged (boolean) - Whether the delete was acknowledged by Milvus.

  • insert_cnt (string) - Always "0" for delete().

  • delete_cnt (string) - The number of rows logically deleted by this operation.

  • upsert_cnt (string) - Always "0" for delete().

  • timestamp (string) - The hybrid timestamp at which the delete became visible.

  • IDs (StringArrayId | NumberArrayId) - The primary keys that were targeted by this delete. For the full field reference, refer to the insert() doc.

  • ResStatus A ResStatus object.

    • code (number) -

      A code that indicates the operation result. It remains 0 if this operation succeeds.

    • error_code (string | number) -

      An error code that indicates an occurred error. It remains Success if this operation succeeds.

    • reason (string) -

      The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.

Example

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]
});