Skip to content

Commit

Permalink
PBM-1187 Added --wait flag to pbm config description
Browse files Browse the repository at this point in the history
Fixed broken reference links

modified:   docs/reference/pbm-commands.md
	modified:   docs/troubleshoot/faq.md
	modified:   docs/usage/cancel-backup.md
	modified:   docs/usage/list-backup.md
  • Loading branch information
nastena1606 committed Jan 18, 2024
1 parent 7c62233 commit 76b4f5e
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/reference/pbm-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ The command accepts the following flags:
| `--file=FILE` | Upload the config information from a YAML file |
| `--set=SET` | Set a new config option value. Specify the option in the `<key.name=value>` format. |
| `-o`, `--out=text` | Shows the output format as either plain text or a JSON object. Supported values: text, json |
| `-w`, `--wait` | Wait for resync of the backup list with the storage to finish. You can only use this flag together with the `--force-resync` flag.|

??? "PBM configuration output"

Expand Down
4 changes: 2 additions & 2 deletions docs/troubleshoot/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
`mongodump` is a "logical" backup solution only while Percona Backup for MongoDB supports both logical and physical backups. Both solutions have equal performance for non-sharded replica sets. However, as opposed to `mongodump`, Percona Backup for MongoDB allows you to achieve the following goals:

* Make consistent backups and restores in sharded clusters.
* Backup / restore both the whole data set and specific namespaces —— databases and collections. (See [Selective backup and restore](features/selective-backup.md) for more information.)
* Backup / restore both the whole data set and specific namespaces —— databases and collections. (See [Selective backup and restore](../features/selective-backup.md) for more information.)
* Restore your database to a specific point in time.
* Run backups / restores on each replica set in parallel while `mongodump` runs in one process on `mongos` node.

Expand All @@ -17,7 +17,7 @@ Starting with version 2.0.1, you can change the time zone for ``pbm logs`` outpu

## Can I restore a single collection with Percona Backup for MongoDB?

Yes. Starting with version 2.0.0, you can restore a single collection with Percona Backup for MongoDB. This functionality is available for logical backups and restores only. To learn more, see [Selective backup and restore](features/selective-backup.md).
Yes. Starting with version 2.0.0, you can restore a single collection with Percona Backup for MongoDB. This functionality is available for logical backups and restores only. To learn more, see [Selective backup and restore](../features/selective-backup.md).

## Can I back up specific shards in a cluster?

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/cancel-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ $ pbm cancel-backup
Backup cancellation has started
```

After the command execution, the backup is marked as canceled in the [pbm status](../manage/status.md) output:
After the command execution, the backup is marked as canceled in the [pbm status](../troubleshoot/status.md) output:

```{.bash data-prompt="$"}
$ pbm status
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/list-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

!!! note

As of version 1.4.0, the `pbm list` command provides the information only about completed backups. To check for running backups, use the [`pbm status`](../reference/pbm-commands.md#pbm-status). For more information, see [Percona Backup for MongoDB status](../manage/status.md).
As of version 1.4.0, the `pbm list` command provides the information only about completed backups. To check for running backups, use the [`pbm status`](../reference/pbm-commands.md#pbm-status). For more information, see [Percona Backup for MongoDB status](../troubleshoot/status.md).

For Percona Backup for MongoDB version 1.3.4 and earlier, the `pbm list` command provides the running backup listed with an
‘In progress’ label. When that is absent, the backup is complete.
Expand Down

0 comments on commit 76b4f5e

Please sign in to comment.