Name		Name	Last commit message	Last commit date
.github		.github
.vscode		.vscode
config		config
errors		errors
ha		ha
hack		hack
log		log
mdb		mdb
metrics		metrics
packaging		packaging
pcsm		pcsm
sel		sel
tests		tests
util		util
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.gitignore		.gitignore
.golangci.yml		.golangci.yml
.trivyignore		.trivyignore
AGENTS.md		AGENTS.md
CODEOWNERS		CODEOWNERS
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
cli_test.go		cli_test.go
go.mod		go.mod
go.sum		go.sum
main.go		main.go
main_test.go		main_test.go
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml
pyrightconfig.json		pyrightconfig.json
recovery.go		recovery.go
recovery_integration_test.go		recovery_integration_test.go

Repository files navigation

Percona ClusterSync for MongoDB

Percona ClusterSync for MongoDB (PCSM) is a tool for cloning and replicating data between MongoDB clusters. It supports both replica sets and sharded clusters, handling initial data cloning followed by continuous change replication.

For more information about PCSM and how to use it, see Percona ClusterSync for MongoDB documentation.

Percona ClusterSync for MongoDB includes the following Features:

Clone data from source to target MongoDB cluster
Real-time change replication via MongoDB Change Streams
Support for both replica sets and sharded clusters
Namespace filtering (include/exclude databases and collections)
Automatic index management on target cluster
CLI tool as well as HTTP API

Installation

You can install Percona ClusterSync for MongoDB in the following ways:

from Percona repository (recommended)
build from source code

Find the installation instructions in the official documentation.

API

PCSM is a CLI tool, but also exposes HTTP API as well.

For reference see PCSM commands and HTTP API docs.

Submit Bug Report / Feature Request

If you find a bug in Percona ClusterSync for MongoDB, submit a report to the project's JIRA issue tracker.

As a general rule of thumb, please try to create bug reports that are:

Reproducible. Include steps to reproduce the problem.
Specific. Include as much detail as possible: which version, what environment, etc.
Unique. Do not duplicate existing tickets.
Scoped to a Single Bug. One bug per report.

When submitting a bug report or a feature, please attach the following information:

The output of the pcsm status command
The output of the pcsm logs command

Licensing

Percona is dedicated to keeping open source open. Whenever possible, we strive to include permissive licensing for both our software and documentation. For this project, we are using the Apache License 2.0 license.