PBM-1294 selective logical backup/restore with Users & Roles#337
PBM-1294 selective logical backup/restore with Users & Roles#337rasika-chivate wants to merge 69 commits intomainfrom
Conversation
it-percona
temporarily deployed
to
PBM-1294-selective-logical-backup/restore-with-Users-&-Roles - pbm-docs PR #337
Render
Destroyed
it-percona
temporarily deployed
to
PBM-1294-selective-logical-backup/restore-with-Users-&-Roles - pbm-docs PR #337
Render
Destroyed
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 10 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Before you start, read about [selective backups known limitations](../features/known-limitations.md#selective-backups-and-restores). | ||
|
|
||
| To make a selective backup, run the `pbm backup` command and provide the value for the `--ns` flag in the format `<database.collection>`. The `--ns` flag value is case sensitive. For example, to back up the "Payments" collection, run the following command: | ||
| To make a selective backup, run the pbm backup command and provide the value for the --ns flag in the format <database.collection>. The --ns flag value is case sensitive. For example, to back up the "Payments" collection, run the following command: |
There was a problem hiding this comment.
The command references pbm backup and --ns flag are missing backtick formatting for consistency with the rest of the documentation. The format should use backticks around code elements like pbm backup and --ns to match the formatting style used elsewhere in the line and throughout the documentation.
| 3. To restore the desired database to a point in time, **along with users and roles**: | ||
|
|
||
| ```bash | ||
| pbm restore --time "<TIMESTAMP>" --ns "db.*" --with-users-and-roles | ||
| ``` |
There was a problem hiding this comment.
The numbering structure appears inconsistent. Step 2 (line 17) contains nested substeps and describes the general restore command, while step 3 (line 30) introduces a variation with --with-users-and-roles. Consider restructuring this as a substep of step 2 (e.g., "2.a" or as a note within step 2) or adding more context to explain why this is a separate numbered step, since it's a variation of the same restore operation rather than a distinct preparatory action.
|
|
||
| ## Selective backup with users and roles | ||
|
|
||
| !!! admonition "Version added: [2.13.0](../release-notes/2.13.0.md)" |
There was a problem hiding this comment.
The link references ../release-notes/2.13.0.md, but this file does not exist in the docs/release-notes directory. The latest release notes file is 2.12.0.md. Either create the 2.13.0.md release notes file or update the link to point to an existing release notes file. The same issue exists on line 16 of docs/features/selective-backup.md.
| !!! admonition "Version added: [2.13.0](../release-notes/2.13.0.md)" | |
| !!! admonition "Version added: [2.12.0](../release-notes/2.12.0.md)" |
There was a problem hiding this comment.
Will be added later.
| ```bash | ||
| pbm backup --ns=invoices.* | ||
| ``` | ||
| To back up multiple namespaces, specify them as a comma-separated list for the --ns flag: `<db1.col1>,<db2.*>,<db3.*>`. The number of namespaces to specify is unlimited. |
There was a problem hiding this comment.
The --ns flag reference is missing backtick formatting. It should be `--ns` to be consistent with the formatting style used throughout the documentation.
| - To restore without the users and roles, skip the `--with-users-and-roles` flag. | ||
|
|
||
| During the restore, Percona Backup for MongoDB retrieves the file for the specified database / collection and restores it. | ||
| - You can specify several namespaces as a comma-separated list for the `--ns` flag: `<db1.*>,<db2.*>`. For example, `--ns=customers.*,invoices.*`. |
There was a problem hiding this comment.
This line has an extra leading space before the hyphen, causing inconsistent indentation with the other bullet points (lines 31 and 35). The indentation should match the other bullets in this list.
| - You can specify several namespaces as a comma-separated list for the `--ns` flag: `<db1.*>,<db2.*>`. For example, `--ns=customers.*,invoices.*`. | |
| - You can specify several namespaces as a comma-separated list for the `--ns` flag: `<db1.*>,<db2.*>`. For example, `--ns=customers.*,invoices.*`. |
docs/usage/pitr-selective.md
Outdated
| 3. To restore the desired database to a point in time, **along with users and roles**: | ||
|
|
||
| ```bash | ||
| pbm restore --time "<TIMESTAMP>" --ns "db.*" --with-users-and-roles |
There was a problem hiding this comment.
The flag syntax --ns "db.*" (with a space) differs from the syntax used elsewhere in the documentation which consistently uses --ns="db.*" (with an equals sign and quotes). For example, see lines 28 and 53 in restore-selective.md and line 73 in features/selective-backup.md. Standardize the syntax to match the rest of the documentation.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Sandra Romanchenko <53295797+sandraromanchenko@users.noreply.github.com>
Provide a detailed documentation of the command used for selective backup and restore. Include instructions on how to optionally include related users and roles in the backup and restoration process. Ensure that all syntax, parameters, and examples are clearly explained.
Refer to the ticket PBM-1294 for more information.