Snapshot
Methods related to snapshot management.
CreateSnapshot() [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.
DescribeSnapshot() [READ MORE]
This operation retrieves detailed metadata about a specific snapshot, including the source collection, partition names, creation timestamp, and storage location.
DropSnapshot() [READ MORE]
This operation permanently deletes a snapshot. Once dropped, the snapshot data cannot be recovered.
GetRestoreSnapshotState() [READ MORE]
This operation queries the status and progress of an asynchronous restore snapshot job.
ListRestoreSnapshotJobs() [READ MORE]
This operation lists all restore snapshot jobs. Optionally filter by collection name or database name.
ListSnapshots() [READ MORE]
This operation lists all snapshot names for a specified collection.
PinSnapshotData() [READ MORE]
This operation pins snapshot data for a collection, preventing it from being garbage collected. Returns a pin ID that can be used to unpin the data later.
RestoreSnapshot() [READ MORE]
This operation restores a snapshot to a target collection. The restore runs asynchronously — use `GetRestoreSnapshotState()` to monitor progress.
UnpinSnapshotData() [READ MORE]
This operation unpins previously pinned snapshot data, allowing it to be garbage collected.