OS Manuals

/usr/bin/fastrestore_tool

From foundationdb-7.3-compat 7.3.79-r7 (enterprise-packages), captured 2026-11-08 by running fastrestore_tool --help (exit 0). permalink

 NOTE: Fast restore aims to support the same fdbrestore option list.
       But fast restore is still under development. The options may not be fully supported.
 Supported options are: --dest-cluster-file, -r, --waitfordone, --logdir
FoundationDB 7.3 (v7.3.79)
Usage: fdbrestore [TOP_LEVEL_OPTIONS] (start | status | abort | wait) [OPTIONS]

 TOP LEVEL OPTIONS:
  --build-flags  Print build information and exit.
  -v, --version  Print version information and exit.
  -h, --help     Display this help and exit.

 ACTION OPTIONS:
  Options for all commands:

  --dest-cluster-file CONNFILE
                 The cluster file to restore data into.
  -t, --tagname TAGNAME
                 The restore tag to act on.  Default is 'default'

  Options for start:

  -r URL         The Backup URL for the restore to read from.
                 Backup URL forms:

                     file://</path/to/base/dir/>
                     blobstore://<api_key>:<secret>:<security_token>@<host>[:<port>]/<name>[?<param>=<value>[&<param>=<value>]...] (Note: The 'bucket' parameter is required.)

  -w, --waitfordone
                 Wait for the restore to complete before exiting.  Prints progress updates.
  -k KEYS        List of key ranges from the backup to restore.
  --keys-file FILE
                 Same as -k option, except keys are specified in the input file.
  --remove-prefix PREFIX
                 Prefix to remove from the restored keys.
  --add-prefix PREFIX
                 Prefix to add to the restored keys
  -n, --dryrun   Perform a trial run with no changes made.
  --log          Enables trace file logging for the CLI session.
  --logdir PATH  Specifies the output directory for trace files. If
                 unspecified, defaults to the current directory. Has
                 no effect unless --log is specified.
  --loggroup LOG_GROUP
                 Sets the LogGroup field with the specified value for all
                 events in the trace output (defaults to `default').
  --trace-format FORMAT
                 Select the format of the trace files. xml (the default) and json are supported.
                 Has no effect unless --log is specified.
  --incremental
                 Performs incremental restore without the base backup.
                 This tells the backup agent to only replay the log files from the backup source.
                 This also allows a restore to be performed into a non-empty destination database.
  --begin-version
                 To be used in conjunction with incremental restore.
                 Indicates to the backup agent to only begin replaying log files from a certain version, instead of the entire set.
  --encryption-key-file                 The AES-128-GCM key in the provided file is used for decrypting backup files.
  --tls-certificate-file CERTFILE
                 The path of a file containing the TLS certificate and CA
                 chain.
  --tls-ca-file CERTAUTHFILE
                 The path of a file containing the CA certificates chain.
  --tls-key-file KEYFILE
                 The path of a file containing the private key corresponding
                 to the TLS certificate.
  --tls-password PASSCODE
                 The passphrase of encrypted private key
  --tls-verify-peers CONSTRAINTS
                 The constraints by which to validate TLS peers. The contents
                 and format of CONSTRAINTS are plugin-specific.
  -v DBVERSION   The version at which the database will be restored.
  --timestamp    Instead of a numeric version, use this to specify a timestamp in YYYY/MM/DD.HH:MI:SS[+/-]HHMM
                 and it will be converted to a version from that time using metadata in orig_cluster_file.
  --orig-cluster-file CONNFILE
                 The cluster file for the original database from which the backup was created.  The original database
                 is only needed to convert a --timestamp argument to a database version.
  --user-data
                  Restore only the user keyspace. This option should NOT be used alongside --system-metadata (below) and CANNOT be used alongside other specified key ranges.
  --system-metadata
                 Restore only the relevant system keyspace. This option should NOT be used alongside --user-data (above) and CANNOT be used alongside other specified key ranges.

  KEYS FORMAT:   "<BEGINKEY> <ENDKEY>" [...]

  BLOB CREDENTIALS
     Blob account secret keys can optionally be omitted from blobstore:// URLs, in which case they will be
     loaded, if possible, from 1 or more blob credentials definition files.

     These files can be specified with the --blob-credentials argument described above or via the environment variable
     FDB_BLOB_CREDENTIALS, whose value is a colon-separated list of files.  The command line takes priority over
     over the environment but all files from both sources are used.

     At connect time, the specified files are read in order and the first matching account specification (user@host)
     will be used to obtain the secret key.

     The JSON schema is:
        { "accounts" : { "user@host" : { "secret" : "SECRETKEY" }, "user2@host2" : { "secret" : "SECRET" } } }
Options (28)
OptionDescriptionSource
--build-flagsPrint build information and exit.help
-v, --versionPrint version information and exit.help
-h, --helpDisplay this help and exit.help
--dest-cluster-file CONNFILEThe cluster file to restore data into.help
-t, --tagname TAGNAMEThe restore tag to act on.help
-r URLThe Backup URL for the restore to read from.help
-w, --waitfordoneWait for the restore to complete before exiting.help
-k KEYSList of key ranges from the backup to restore.help
--keys-file FILESame as -k option, except keys are specified in the input file.help
--remove-prefix PREFIXPrefix to remove from the restored keys.help
--add-prefix PREFIXPrefix to add to the restored keyshelp
-n, --dryrunPerform a trial run with no changes made.help
--logEnables trace file logging for the CLI session.help
--logdir PATHSpecifies the output directory for trace files.help
--loggroup LOG_GROUPSets the LogGroup field with the specified value for all events in the trace output (defaults to `default').help
--trace-format FORMATSelect the format of the trace files.help
--incrementalPerforms incremental restore without the base backup.help
--begin-versionTo be used in conjunction with incremental restore.help
--encryption-key-fileThe AES-128-GCM key in the provided file is used for decrypting backup files.help
--tls-certificate-file CERTFILEThe path of a file containing the TLS certificate and CA chain.help
--tls-ca-file CERTAUTHFILEThe path of a file containing the CA certificates chain.help
--tls-key-file KEYFILEThe path of a file containing the private key corresponding to the TLS certificate.help
--tls-password PASSCODEThe passphrase of encrypted private keyhelp
--tls-verify-peers CONSTRAINTSThe constraints by which to validate TLS peers.help
--timestampInstead of a numeric version, use this to specify a timestamp in YYYY/MM/DD.HH:MI:SS[+/-]HHMM and it will be converted to a version from that time using metadata in orig_cluster_file.help
--orig-cluster-file CONNFILEThe cluster file for the original database from which the backup was created.help
--user-dataRestore only the user keyspace.help
--system-metadataRestore only the relevant system keyspace.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.