restore_snapshot()

This operation restores a snapshot to a target collection. The restore runs asynchronously — use get_restore_snapshot_state() to monitor progress.

Request Syntax

restore_snapshot(
    collection_name: str,
    snapshot_name: str,
    rewrite_data: bool = False,
    timeout: Optional[float] = None,
    **kwargs
) -> int

PARAMETERS:

• collection_name (str) - [REQUIRED] The name of the target collection to restore the snapshot into.

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

• rewrite_data (bool) - Whether to overwrite existing data in the target collection. Defaults to False.

• timeout (Optional[float]) - An optional duration of time in seconds to allow for the RPC.

RETURN TYPE:

int

The restore job ID. Use this ID with get_restore_snapshot_state() to track the restore progress.

EXCEPTIONS:

• MilvusException

  If the snapshot does not exist, the target collection is unavailable, or the operation fails.

Examples

from pymilvus import MilvusClient
import time

client = MilvusClient(uri="http://localhost:19530")

# Start restore and get job ID
job_id = client.restore_snapshot(
    snapshot_name="backup_20260418",
    collection_name="restored_collection",
)

# Poll for completion
while True:
    state = client.get_restore_snapshot_state(job_id=job_id)
    if state.state == "RestoreSnapshotCompleted":
        print(f"Restore complete: {state.progress}%")
        break
    elif state.state == "RestoreSnapshotFailed":
        print(f"Restore failed: {state.reason}")
        break
    print(f"In progress: {state.progress}%")
    time.sleep(2)