Skip to content
logo
Percona Backup for MongoDB
Restore 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
        • Backup options
        • Restore options
          • batchSize
          • numInsertionWorkers
          • numDownloadWorkers
          • maxDownloadBufferMb
          • downloadChunkMb
          • mongodLocation
          • mongodLocationMap
      • Glossary
    • Contribution guidelines
    • Copyright and licensing
    • Trademark policy

    • batchSize
    • numInsertionWorkers
    • numDownloadWorkers
    • maxDownloadBufferMb
    • downloadChunkMb
    • mongodLocation
    • mongodLocationMap

    Restore options¶

    restore:
      batchSize: <int>
      numInsertionWorkers: <int>
      numDownloadWorkers: <int>
      maxDownloadBufferMb: <int>
      downloadChunkMb: <int>
      mongodLocation: <string>
      mongodLocationMap:
         "node01:2017": <string>
         "node03:27017": <string>
    

    batchSize¶

    Type: int
    Default: 500

    The number of documents to buffer.

    numInsertionWorkers¶

    Type: int
    Default: 10

    The number of workers that add the documents to buffer.

    numDownloadWorkers¶

    Type: int
    Default: number of CPU cores

    The number of workers that request data chunks from the storage during the restore. The default value equals to the number of CPU cores.

    maxDownloadBufferMb¶

    Type: int

    The maximum size of the in-memory buffer that is used to download files from the S3 storage. When unspecified or set to 0, the size cannot exceed the value calculated as numDownloadWorkers * downloadChunkMb * 16 MB. By default, the number of CPU cores * 32 * 16 MB.

    downloadChunkMb¶

    Type: int
    Default: 32

    The size of the data chunk in MB to download from the S3 storage.

    mongodLocation¶

    Type: string

    The custom path to mongod binaries. When undefined, Percona Backup for MongoDB uses the default path to make database restarts during physical restore.

    mongodLocationMap¶

    Type: array of strings

    The list of custom paths to mongod binaries on every node. Percona Backup for MongoDB uses the values to make restarts of the database during physical restore.

    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.