Skip to content

PCSM-230 Documented the use of include and exclude filters for the same db #19

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.

Sign up for GitHub

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

Merged
nastena1606 merged 4 commits into from
Jan 13, 2026
Merged

PCSM-230 Documented the use of include and exclude filters for the same db #19

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4d8b8e7
PCSM-230 Documented the use of include and exclude filters for the sa…
nastena1606 Dec 17, 2025
fb18d1a
Update docs/plm-commands.md
nastena1606 Dec 17, 2025
005d266
Apply suggestion from @nastena1606
nastena1606 Jan 13, 2026
9fd6acc
Apply suggestion from @nastena1606
nastena1606 Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/install/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@

To include or exclude a specific database and all collections it includes, pass it in the format `mydb.*`.

When both include and exclude filters are used, the exclude filter takes precedence. For instance, if you include all collections in the `mydb` database but exclude `mydb.users`, PLM will replicate all collections from `mydb` **except** `mydb.users`.

Check notice on line 46 in docs/install/usage.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/install/usage.md#L46 

[Google.Passive] In general, use active voice instead of passive voice ('are used').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are used').", "location": {"path": "docs/install/usage.md", "range": {"start": {"line": 46, "column": 39}}}, "severity": "INFO"}

Check notice on line 46 in docs/install/usage.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/install/usage.md#L46 

[Google.Acronyms] Spell out 'PLM', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'PLM', if it's unfamiliar to the audience.", "location": {"path": "docs/install/usage.md", "range": {"start": {"line": 46, "column": 180}}}, "severity": "INFO"}

Check warning on line 46 in docs/install/usage.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/install/usage.md#L46 

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/install/usage.md", "range": {"start": {"line": 46, "column": 184}}}, "severity": "WARNING"}

=== "Command line"

```{.bash data-prompt="$"}
Expand Down
2 changes: 1 addition & 1 deletion docs/pcsm-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
| Name | Description|
| -----| -----------|
| `--include-namespaces` | Replicate only the specified namespaces. Multiple namespaces are supported as a comma separated list. The number of namespaces to specify is unlimited|
| `--exclude-namespaces` | Replicate everything except the specified namespaces. Multiple namespaces are supported as a comma separated list. The number of namespaces to specify is unlimited|
| `--exclude-namespaces` | Replicate everything except the specified namespaces. Multiple namespaces are supported as a comma separated list. The number of namespaces to specify is unlimited. <br> When both `--include-namespaces` and `--exclude-namespaces` flags are specified, the exclude filters take precedence. For example, if the `--include-namespaces` includes `db1.*` and `--exclude-namespaces` has `db1.users`, PLM syncs all collections of `db1` **except** `db1.users`.|

Check notice on line 49 in docs/pcsm-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/pcsm-commands.md#L49 

[Google.Passive] In general, use active voice instead of passive voice ('are supported').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are supported').", "location": {"path": "docs/pcsm-commands.md", "range": {"start": {"line": 49, "column": 102}}}, "severity": "INFO"}

Check notice on line 49 in docs/pcsm-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/pcsm-commands.md#L49 

[Google.Passive] In general, use active voice instead of passive voice ('is unlimited').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is unlimited').", "location": {"path": "docs/pcsm-commands.md", "range": {"start": {"line": 49, "column": 179}}}, "severity": "INFO"}

Check notice on line 49 in docs/pcsm-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/pcsm-commands.md#L49 

[Google.Passive] In general, use active voice instead of passive voice ('are specified').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are specified').", "location": {"path": "docs/pcsm-commands.md", "range": {"start": {"line": 49, "column": 265}}}, "severity": "INFO"}

Check notice on line 49 in docs/pcsm-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/pcsm-commands.md#L49 

[Google.Acronyms] Spell out 'PLM', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'PLM', if it's unfamiliar to the audience.", "location": {"path": "docs/pcsm-commands.md", "range": {"start": {"line": 49, "column": 421}}}, "severity": "INFO"}


### reset
Expand Down