truncateCollection()

この操作はコレクションからすべてのデータを削除しますが、コレクションのスキーマと構造は保持します。

javascript

await milvusClient.truncateCollection(data: TruncateCollectionRequest)

Notes

• 元に戻せない操作

  コレクションを truncate すると、すべてのデータが完全に削除されます。

• スキーマは保持されます

  コレクションの構造、フィールド、インデックス、およびプロパティはそのまま保持されます。

リクエスト構文

javascript

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

パラメーター:

• db_name (string) -

  コレクションを含むデータベースの名前。

• collection_name (string) -

  [必須]

  対象コレクションの名前。

• timeout (number) -

  ミリ秒単位の RPC タイムアウト。

戻り値:

Promise<ResStatus>

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

javascript

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

パラメーター:

• code (number) -

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

• error_code (string | number) -

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

• reason (string) -

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

例

基本的な使用方法

javascript

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

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

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

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

データベースを指定する場合

javascript

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