Skip to content
logo
Percona Backup for MongoDB
Point-in-time recovery options
Initializing search
    percona/pbm-docs
    percona/pbm-docs
    • Home
      • Release notes index
      • Percona Backup for MongoDB 2.2.1 (2023-07-27)
      • Percona Backup for MongoDB 2.2.0 (2023-07-13)
      • Percona Backup for MongoDB 2.1.0 (2023-04-18)
      • Percona Backup for MongoDB 2.0.5 (2023-03-23)
      • Percona Backup for MongoDB 2.0.4 (2023-02-21)
      • Percona Backup for MongoDB 2.0.3 (2023-01-11)
      • Percona Backup for MongoDB 2.0.2 (2022-10-27)
      • Percona Backup for MongoDB 2.0.1 (2022-10-12)
      • Percona Backup for MongoDB 2.0.0 (2022-09-21)
      • Percona Backup for MongoDB 1.8.1 (2022-07-12)
      • Percona Backup for MongoDB 1.8.0 (2022-06-09)
      • Percona Backup for MongoDB 1.7.0 (2022-04-18)
      • Percona Backup for MongoDB 1.6.1 (2021-11-04)
      • Percona Backup for MongoDB 1.6.0 (2021-08-16)
      • Percona Backup for MongoDB 1.5.0 (2021-05-10)
      • Percona Backup for MongoDB 1.4.1 (2021-01-28)
      • Percona Backup for MongoDB 1.4.0 (2020-12-24)
      • Percona Backup for MongoDB 1.3.4 (2020-11-19)
      • Percona Backup for MongoDB 1.3.3 (2020-11-04)
      • Percona Backup for MongoDB 1.3.2 (2020-10-14)
      • Percona Backup for MongoDB 1.3.1 (2020-09-03)
      • Percona Backup for MongoDB 1.3.0 (2020-08-26)
      • Percona Backup for MongoDB 1.2.1 (2020-07-27)
      • Percona Backup for MongoDB 1.2.0 (2020-05-13)
      • Percona Backup for MongoDB 1.1.3 (2020-04-14)
      • Percona Backup for MongoDB 1.1.1 (2020-01-31)
      • Percona Backup for MongoDB 1.1.0 (2020-01-16)
      • Percona Backup for MongoDB 1.0.0 (2019-09-19)
      • Percona Backup for MongoDB 0.5.0 (2019-06-17)
      • Backup and restore types
      • Logical backups and restores
      • Physical backups and restores
      • Selective backup and restore
      • Incremental physical backups
      • Point-in-time recovery
      • Snapshot-based physical backups
      • Comparison with MongoDB
      • How PBM works
        • PBM architecture
        • pbm-agent
        • PBM CLI
        • PBM control collections
          • Overview
          • Remote backup storage configuration examples
      • Authentication
      • Supported MongoDB deployments
      • Supported MongoDB versions
        • Overview
        • Method 1. From repositories
        • Method 2. Build from source
        • Method 3. Download tarballs
        • Method 4. Deploy on Kubernetes
      • Set up and configure
      • Make a backup
      • Restore a backup
      • Make a point-in-time restore
      • List backups
      • View detailed information about a backup
      • Schedule backups
      • Cancel a backup
      • Delete backups
      • View restore progress
      • Replay oplog from arbitrary start time
      • View backup logs
      • PBM configuration via pipelines
      • Automate access to S3 buckets for PBM
      • Diagnose PBM
      • Check status
      • Upgrade PBM
      • Remove PBM
    • FAQ
      • PBM commands
        • Configuration file
        • Remote backup storage options
        • Point-in-time recovery options
          • pitr.enabled
          • pitr.oplogSpanMin
          • pitr.compression
          • pitr.compressionLevel
          • pitr.oplogOnly
        • Backup options
        • Restore options
      • Glossary
    • Contribution guidelines
    • Copyright and licensing
    • Trademark policy

    • pitr.enabled
    • pitr.oplogSpanMin
    • pitr.compression
    • pitr.compressionLevel
    • pitr.oplogOnly

    Point-in-time recovery options¶

    pitr:
      enabled: <boolean>
      oplogSpanMin: <float64>
      compression: <string>
      compressionLevel: <int>
    

    pitr.enabled¶

    Type: boolean
    Default: False

    Enables point-in-time recovery

    pitr.oplogSpanMin¶

    Type: float64
    Default: 10

    The duration of an oplog span in minutes. If set when the pbm-agent is making an oplog slice, the slice’s span is updated right away.

    If the new duration is smaller than the previous one, the pbm-agent is triggered to save a new slice with the updated span. If the duration is larger, then the next slice is saved with the updated span in scheduled time.

    pitr.compression¶

    Type: string
    Default: s2

    The compression method for Point-in-Time Recovery oplog slices. Available in Percona Backup for MongoDB as of version 1.7.0.

    Supported values: gzip, snappy, lz4, s2, pgzip, zstd. Default: s2.

    pitr.compressionLevel¶

    Type: int

    The compression level is from 0 till 10. The default value depends on the compression method used.

    The following table shows available compression levels per compression method:

    Compression method Compression levels Default
    zstd 1 - fastest speed, 2 - default, 3 - better compression, 4 - best compression 2
    snappy no levels
    lz4 From 1 (fastest) to 16 1
    gzip and pgzip -1 - default compression, 0 - no compression, 1 - best speed, 9 - best compression -1

    Note that the greater value you specify, the more time and computing resources it will take to compress the data.

    pitr.oplogOnly¶

    Type: boolean
    Default: False
    Required: NO

    Controls whether the base backup is required to start Point-in-Time recovery oplog slicing. When set to true, Percona Backup for MongoDB saves oplog chunks without the base backup snapshot.

    Available in Percona Backup for MongoDB starting with version 1.8.0. To learn more about the usage, see Point-in-Time Recovery oplog replay.

    Contact Us

    For free technical help, visit the Percona Community Forum.

    To report bugs or submit feature requests, open a JIRA ticket.

    For paid support and managed or consulting services , contact Percona Sales.


    Last update: August 22, 2023
    Created: August 22, 2023
    Percona LLC and/or its affiliates, © 2023
    Made with Material for MkDocs

    Cookie consent

    We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better. Read more about Percona Cookie Policy.