Skip to content

Percona Backup for MongoDB Documentation

Percona Backup for MongoDB is a distributed, low-impact solution for achieving consistent backups of MongoDB sharded clusters and replica sets.

As of version 1.7.0, Percona Backup for MongoDB supports both physical and logical backups and restores. Point-in-Time Recovery is currently supported only for logical backups.

Supported MongoDB versions

Percona Backup for MongoDB is compatible with the following MongoDB versions:

Important

Percona Backup for MongoDB doesn’t work on standalone MongoDB instances. This is because Percona Backup for MongoDB requires an oplog to guarantee backup consistency. Oplog is available on nodes with replication enabled.

For testing purposes, you can deploy Percona Backup for MongoDB on a single-node replica set. ( Specify the replication.replSetName option in the configuration file of the standalone server.)

See also

MongoDB Documentation: Convert a Standalone to a Replica Set

https://docs.mongodb.com/manual/tutorial/convert-standalone-to-replica-set/

The Percona Backup for MongoDB project is inherited from and replaces mongodb_consistent_backup, which is no longer actively developed or supported.

Features

  • Logical backup and restore

  • Physical (a.k.a. ‘hot’) backup and restore (with Percona Server for MongoDB 4.2.15-16, 4.4.6-8, 5.0.2-1 and higher)

  • Works for both for sharded clusters and classic, non-sharded replica sets.

  • Point-in-time recovery (for logical backups only)

  • Simple command-line management utility

  • Simple, integrated-with-MongoDB authentication

  • Distributed transaction consistency with MongoDB 4.2+

  • Use with any S3-compatible storage

  • Users with classic, locally-mounted remote filesystem backup servers can use ‘filesystem’ instead of ‘s3’ storage type.

Introduction

Getting started

Usage

Details

How to

FAQ

FAQ

Reference

Release notes

Release notes