Percona Link for MongoDB commands¶
Overview¶
Percona Link for MongoDB is a replication tool for MongoDB clusters. It provides commands to manage and monitor the replication process between source and target MongoDB clusters.
Commands¶
version¶
Display the current version of Percona Link for MongoDB.
$ plm version
status¶
Get the status of the replication process.
$ plm status
start¶
Starts cluster replication.
$ plm start
To start a filtered replication, pass the namespaces (databases and collections) that you want to include/exclude from replication.
$ plm start \
--include-namespaces="db1.collection1,db2.collection2" \
--exclude-namespaces="db3.collection3"
To include or exclude a specific database and all collections it includes, pass it in the format mydb.*.
Available flags:
| 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 |
reset¶
Resets the PLM state and deletes the metadata collections from target deployment. After the command execution, you must restart the PLM service and start the data replication from scratch. Read more about the flow in Troubleshooting guide
$ plm reset --target
finalize¶
Finalize cluster replication.
$ plm finalize
pause¶
Pause cluster replication.
$ plm pause
resume¶
Resume cluster replication.
$ plm resume
Available flags:
| Name | Description |
|---|---|
--from-failure |
Resume replication from the last failure point |
Created: September 8, 2025