createSnapshot()

此操作会为 Collection 创建快照。快照会捕获 Collection 及其数据的当前状态。

typescript

await milvusClient.createSnapshot(data: CreateSnapshotReq)

请求语法

typescript

await milvusClient.createSnapshot({
    collection_name: string,
    snapshot_name: string,
    description?: string,
    compaction_protection_seconds?: number | string,
    db_name?: string,
    timeout?: number,
    client_request_id?: string,
})

参数：

• collection_name (string) -
  [REQUIRED]
  要创建快照的 Collection 名称。

• snapshot_name (string) -
  [REQUIRED]
  快照名称。

• description (string) -
  可选的快照描述。

• compaction_protection_seconds (number | string) -
  保护被引用 Segment 免受 Compaction 影响的时长。可选。

• db_name (string) -
  Database 名称。可选。

• timeout (number) -
  RPC 允许的可选时长，单位为毫秒。如果设置为 undefined，客户端会持续等待，直到服务器响应或发生错误。默认值为 undefined。

• client_request_id (string) -
  用于请求跟踪的追踪 ID。可选。

返回：

Promise<ResStatus>

异常：

• MilvusError

  当此操作期间发生任何错误时，将引发此异常。

示例

javascript

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

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

const res = await client.createSnapshot({
    collection_name: 'my_collection',
    snapshot_name: 'snapshot_2024_01',
    description: 'Monthly backup',
});