Vladsz83 commented on code in PR #13666: URL: https://github.com/apache/ignite/pull/13666#discussion_r4323453281
########## docs/_docs/snapshots/snapshots.adoc: ########## @@ -287,9 +287,49 @@ control.(sh|bat) --snapshot restore snapshot_09062021 --groups cache-group1,cach control.(sh|bat) --snapshot restore snapshot_09062021 --increment 1 ---- +== Listing Snapshots + +To list snapshots created on the cluster, use the following command. + +[tabs] +-- +tab:Unix[] +[source,shell] +---- +# List all snapshots in the default snapshot directory. +control.sh --snapshot list + +# List all snapshots in the "/tmp/ignite/snapshots" folder. +control.sh --snapshot list --src /tmp/ignite/snapshots +---- + +tab:Windows[] +[source,shell] +---- +# List all snapshots in the default snapshot directory. +control.bat --snapshot list + +# List all snapshots in the "C:\tmp\ignite\snapshots" folder. +control.bat --snapshot list --src C:\tmp\ignite\snapshots +---- +-- + +=== List operation notes + +* The list operation is read-only. It does not modify any snapshot data. +* A snapshot is detected by its metadata. If the metadata is missing or cannot be read, the snapshot is ignored. +* The operation reads snapshot metadata and incremental snapshot metadata. On most platforms, this does not interfere +with concurrent modification or deletion of snapshots. On Windows, deleting a snapshot at the exact moment its +metadata is being read might be incomplete and require repeating or manual result control. The probability of this is low. +* Listing and size calculation do not validate snapshots or verify checksums. +* If a snapshot is being created or deleted, or is corrupted, it might be skipped or reported partially +(for example, with an underestimated size). The operation reads what it can and ignores most errors. +* The list operation is expected to be fast, so, unlike snapshot creation or restoration, it cannot be canceled and has no status. + + == Getting Snapshot Operation Status -The status of the current snapshot operation in the cluster can be obtained using the `control.sh|bat` script or JMX interface: +The status of the create/restore snapshot operations in the cluster can be obtained using the `control.sh|bat` script or JMX interface: Review Comment: > I`d prefer a previous version of this line, why we need to change it ? This emphasizes that the status is available only for creation and restoration — not for any operation, not for the lists (and not for deletion either). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
