DocsUsage GuideParameter Reference

Parameter Reference

Complete guide to configuration and runtime parameters

Setting Parameters

Use param <name> <value>; to set parameters. Use show; to view current values.

This documentation applies to Linux and source versions MongoDB 6.0.0, 7.0.0 and 8.0.0. Freeze source copies and launch PDU from a directory outside the sources. State and output use the launch directory without separate path settings. Confirm other versions and special layouts separately.

Configuration File (pdu.ini)

MONGODBDATA

Complete frozen WiredTiger data directory. Directory recovery requires matching metadata, catalog and collection files.

MONGODBDATA=/recovery-input/mongodb/source/dbpath
DISK_PATH

Single-file or image source, distinct from directory sources.

DISK_PATH=
RESTYPE

Recovery type for scan and restore: delete or update, without positional operation arguments.

RESTYPE=delete
RECOVERY_AT

Source MongoDB logical time in SECONDS:INCREMENT, mutually exclusive with recoverytime.

RECOVERY_AT=none
RECOVERY_TIME

Requires Z or an explicit time zone and accepts only a unique recorded oplog commit wall-clock boundary, without interpolation.

RECOVERY_TIME=none
CATALOG_SALVAGE

Retain independent catalog, UUID, ident and WT-definition relationships when metadata is missing, without reconstructing Turtle roots or guessing attribution.

CATALOG_SALVAGE=false
JOURNAL_COMPRESSOR

Choose snappy, zlib, zstd or none to match the original WT logs, without guessing.

JOURNAL_COMPRESSOR=snappy
SOURCE_VERSIONRequired

Declare the exact source version. Source versions covered here are 6.0.0, 7.0.0 and 8.0.0. unknown allows corresponding metadata probing without guessing the version.

SOURCE_VERSION=unknown
SOURCE_KINDRequired

copy denotes a file or directory copy; imagecopy denotes an image copy.

SOURCE_KIND=unknown
SOURCE_FROZENRequired

Explicitly declare frozen sources. The declaration does not replace consistency preservation by the source engineer.

SOURCE_FROZEN=false
MIN_FREE_BYTES

Minimum free-space guard before execution, in bytes.

MIN_FREE_BYTES=1073741824
RESMODE

current reads the selected checkpoint; history reads historical sources; all retains physical versions permitted by the selected path. Scope differs by path.

RESMODE=current
EXMODE

bson exports BSON; json exports Canonical Extended JSON line files.

EXMODE=bson
HS_SOURCE_ABI

Retain limits when the source ABI is unknown. Explicit le64 applies to corresponding reverse MODIFY parsing without automatic assumption.

HS_SOURCE_ABI=unknown
DSOFF

Confirmed scan start offset, in bytes.

DSOFF=0
SCAN_END

Exclusive end position for unmapped imagecopy/all scanning. Set from actual sources without fabricating a file map.

SCAN_END=0
SCAN_STEP

Scan step, in bytes.

SCAN_STEP=512
EXTENT_MAP

Declared logical-extent mapping for one file, retaining holes and source relationships.

EXTENT_MAP=
DIRECTORY_EXTENTS

Declared block-source manifest for missing directory files. A readable directory root and matching metadata are required.

DIRECTORY_EXTENTS=
OPERATION_FROM

For ds preimage only: inclusive lower operation-timestamp bound, formatted SECONDS:INCREMENT.

OPERATION_FROM=none
OPERATION_BEFORE

For ds preimage only: exclusive upper operation-timestamp bound. Reset both bounds to none before ordinary scan/restore.

OPERATION_BEFORE=none

Runtime Path Parameters

datapathstringDefault: unset

Complete frozen WiredTiger data directory. Directory recovery requires matching metadata, catalog and collection files.

param datapath /recovery-input/mongodb/source/dbpath;
diskpathstringDefault: unset

Single-file or image source, distinct from directory sources.

param diskpath /recovery-input/mongodb/source/collection-1.wt;

Incident-Time and Source Parameters

restypestringDefault: delete

Recovery type for scan and restore: delete or update, without positional operation arguments.

param restype update;
recoveryattimestampDefault: none

Source MongoDB logical time in SECONDS:INCREMENT, mutually exclusive with recoverytime.

param recoveryat 1700000000:1;
recoverytimedatetimeDefault: none

Requires Z or an explicit time zone and accepts only a unique recorded oplog commit wall-clock boundary, without interpolation.

param recoverytime 2026-10-04T10:00:00Z;
catalogsalvagebooleanDefault: false

Retain independent catalog, UUID, ident and WT-definition relationships when metadata is missing, without reconstructing Turtle roots or guessing attribution.

param catalogsalvage true;
journalcompressorstringDefault: snappy

Choose snappy, zlib, zstd or none to match the original WT logs, without guessing.

param journalcompressor snappy;

Source Parameters

sourceversionstringDefault: unknown

Declare the exact source version. Source versions covered here are 6.0.0, 7.0.0 and 8.0.0. unknown allows corresponding metadata probing without guessing the version.

param sourceversion 8.0.0;
sourcekindstringDefault: unknown

copy denotes a file or directory copy; imagecopy denotes an image copy.

param sourcekind copy;
sourcefrozenbooleanDefault: false

Explicitly declare frozen sources. The declaration does not replace consistency preservation by the source engineer.

param sourcefrozen true;
minfreebytesintegerDefault: 1073741824

Minimum free-space guard before execution, in bytes.

param minfreebytes 1073741824;

Recovery Parameters

resmodestringDefault: current

current reads the selected checkpoint; history reads historical sources; all retains physical versions permitted by the selected path. Scope differs by path.

param resmode history;
exmodestringDefault: bson

bson exports BSON; json exports Canonical Extended JSON line files.

param exmode bson;
hssourceabistringDefault: unknown

Retain limits when the source ABI is unknown. Explicit le64 applies to corresponding reverse MODIFY parsing without automatic assumption.

param hssourceabi le64;

Scan Range Parameters

dsoffintegerDefault: 0

Confirmed scan start offset, in bytes.

param dsoff 193;
scanendintegerDefault: 0

Exclusive end position for unmapped imagecopy/all scanning. Set from actual sources without fabricating a file map.

param scanend 24512;
scanstepintegerDefault: 512

Scan step, in bytes.

param scanstep 512;
extentmapstringDefault: unset

Declared logical-extent mapping for one file, retaining holes and source relationships.

param extentmap /recovery-input/mongodb/source/collection-extents.json;
directoryextentsstringDefault: unset

Declared block-source manifest for missing directory files. A readable directory root and matching metadata are required.

param directoryextents /recovery-input/mongodb/source/directory-extents.json;

Operation Range Parameters

operationfromtimestampDefault: none

For ds preimage only: inclusive lower operation-timestamp bound, formatted SECONDS:INCREMENT.

param operationfrom 1700000000:1;
operationbeforetimestampDefault: none

For ds preimage only: exclusive upper operation-timestamp bound. Reset both bounds to none before ordinary scan/restore.

param operationbefore 1700000010:1;
MongoDB 文档