restoreSnapshot()

This operation restores a collection from a snapshot to a new or existing collection.

await milvusClient.restoreSnapshot(data: RestoreSnapshotReq)

Request Syntax

await milvusClient.restoreSnapshot({
    snapshot_name: string,
    source_collection_name: string,
    target_collection_name: string,
    source_db_name?: string,
    target_db_name?: string,
    timeout?: number,
    client_request_id?: string,
})

PARAMETERS:

• snapshot_name (string) - [REQUIRED] The name of the snapshot to restore from.

• source_collection_name (string) - [REQUIRED] The name of the source collection.

• target_collection_name (string) - [REQUIRED] The name of the target collection to restore to.

• source_db_name (string) - The source database name. Optional.

• target_db_name (string) - The target database name. Optional.

• timeout (number) - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or an error occurs. Default is undefined.

• client_request_id (string) - A trace ID for request tracking. Optional.

RETURNS:

Promise

EXCEPTIONS:

• MilvusError

  This exception will be raised when any error occurs during this operation.

Example

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

const client = new MilvusClient({
    address: 'localhost:19530',
    token: 'root:Milvus',
});

const res = await client.restoreSnapshot({
    snapshot_name: 'snapshot_2024_01',
    source_collection_name: 'my_collection',
    target_collection_name: 'restored_collection',
});