-
Notifications
You must be signed in to change notification settings - Fork 614
HDDS-13755. Add doc for ozone sh snapshot listDiff command #9238
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
|
|
@@ -100,6 +100,32 @@ Manage snapshots using `ozone sh` or `ozone fs` (Hadoop-compatible) commands: | |||
| Output prefixes: `+` (add), `-` (delete), `M` (modify), `R` (rename). Use `-p`, `-t` for pagination. | ||||
| Manage diff jobs: `ozone sh snapshot listDiff /vol1/bucket1`, `ozone sh snapshot cancelDiff <jobId>`. | ||||
|
|
||||
| * **List Snapshot Diff Jobs:** Lists snapshot diff jobs for a bucket. | ||||
| ```shell | ||||
| ozone sh snapshot listDiff /vol1/bucket1 | ||||
| ``` | ||||
| By default, lists jobs with `in_progress` status. Use `--job-status` to filter by specific status: | ||||
| ```shell | ||||
| # List jobs with specific status (queued, in_progress, done, failed, rejected) | ||||
| ozone sh snapshot listDiff /vol1/bucket1 --job-status done | ||||
| ``` | ||||
| Use `--all-status` to list all jobs regardless of status: | ||||
| ```shell | ||||
| # List all snapshot diff jobs regardless of status | ||||
| ozone sh snapshot listDiff /vol1/bucket1 --all-status | ||||
| ``` | ||||
| **Note:** The difference between `--all-status` and `-all` (or `-a`): | ||||
| * `--all-status`: Controls which jobs to show based on status (lists all jobs regardless of status) | ||||
| * `-all` (or `-a`): Controls the number of results returned (pagination option, removes pagination limit, **not related to snapdiff job status**) | ||||
|
|
||||
| For example: | ||||
| ```shell | ||||
| # List all jobs regardless of status, with pagination limit removed | ||||
| ozone sh snapshot listDiff /vol1/bucket1 --all-status -all | ||||
| # Or limit results to 10 items | ||||
| ozone sh snapshot listDiff /vol1/bucket1 --all-status -l 10 | ||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. -l defaults to 100: ozone/hadoop-ozone/cli-shell/src/main/java/org/apache/hadoop/ozone/shell/ListLimitOptions.java Line 47 in 584ebb9
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm fine to not mention it since it's too detailed. The pagination limit default is also applicable to other commands so mentioning it here isn't appropriate.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @jojochuang thanks for the feedback! |
||||
| ``` | ||||
|
|
||||
| * **Rename Snapshot:** | ||||
| ```shell | ||||
| ozone sh snapshot rename /vol1/bucket1 <oldName> <newName> | ||||
|
|
||||
Uh oh!
There was an error while loading. Please reload this page.