Snapshot

Private Preview

Addedv3.0.x

Methods related to snapshot management.

create_snapshot() [READ MORE]

This operation creates a point-in-time snapshot of a collection. Use snapshots to back up collection data and metadata for disaster recovery or migration.

describe_snapshot() [READ MORE]

This operation retrieves detailed metadata about a specific snapshot, including the source collection, partition names, creation timestamp, and storage location.

drop_snapshot() [READ MORE]

This operation permanently deletes a snapshot. Once dropped, the snapshot data cannot be recovered.

get_restore_snapshot_state() [READ MORE]

This operation queries the status and progress of an asynchronous restore snapshot job.

list_restore_snapshot_jobs() [READ MORE]

This operation lists all restore snapshot jobs. Optionally filter by collection name to see restore jobs targeting a specific collection.

list_snapshots() [READ MORE]

This operation lists all snapshot names. Optionally filter by collection name to list snapshots belonging to a specific collection.

pin_snapshot_data() [READ MORE]

This operation pins snapshot data for a period of time so garbage collection does not remove it while you export or back up files.

restore_snapshot() [READ MORE]

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

unpin_snapshot_data() [READ MORE]

This operation releases a snapshot pin created by `pinsnapshotdata()` so normal snapshot data garbage collection can resume.