truncateCollection()

Addedv2.6.x

This operation removes all data from a collection but retains the collection schema and structure.

await milvusClient.truncateCollection(data: TruncateCollectionRequest)

📘Notes

• Irreversible operation

Truncating a collection permanently removes all data.

• Schema preserved

The collection structure, fields, indexes, and properties remain intact.

Request Syntax

truncateCollection({
    db_name?: string,
    collection_name: string,
    timeout?: number
})

PARAMETERS:

• db_name (string) -

  The name of the database containing the collection.

• collection_name (string) -

  [REQUIRED]

  The name of the target collection.

• timeout (number) -

  RPC timeout in milliseconds.

RETURNS:

Promise<ResStatus>

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

{
    code: number,
    error_code: string | number,
    reason: string
}

PARAMETERS:

• 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

Basic usage

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

const milvusClient = new MilvusClient({
  address: 'localhost:19530',
  token: 'YOUR_CLUSTER_TOKEN',
});

// Truncate collection
const res = await milvusClient.truncateCollection({
  collection_name: 'my_collection',
});

console.log(res);
// Output: { error_code: 'Success', reason: '' }

With database specified

const res = await milvusClient.truncateCollection({
  db_name: 'my_database',
  collection_name: 'my_collection',
});