mxrestore

This document introduces the data recovery tool mxrestore.

1 Description

mxrestore is used to restore data backed up using the mxbackup tool.
mxrestore supports recovery of data backed up by mxbackup in S3 object storage.

2 Parameter information

Parameter name	Description
--backup-dir directory	Absolute path to backup data that needs to be restored
--create-db	Create database before recovering data
--data-only	Restore only data, not meta information
--debug	Output log information at debug level
--exclude-schema schema	Schema excluded when recovering, this parameter can be specified by using multiple times
--exclude-schema-file file	A list of schemas that need to be excluded
--exclude-table table	Table excluded during recovery, this parameter can be specified by using multiple times
--exclude-table-file file	A list file containing tables to be excluded
--help	Show help information
--include-schema schema	Specify the schema that needs to be restored. You can specify multiple schemas through multiple uses
--include-schema-file file	Specify the list of schemas that need to be restored
--include-table table	Specify the table that needs to be restored, and multiple tables can be specified through multiple use
--include-table-file file	Specify a list file containing the tables to be restored
--incremental	Incremental recovery, suitable for AO table
--jobs num	The number of concurrent connections during recovery, default is 1
--metadata-only	Restore only metadata, not data in table
--on-error-continue	Record logs and continues when an error is encountered
--plugin-config file	Specify the location of the plug-in configuration file
--quiet	Do not display all non-alarm, non-error log information
--redirect-db db	Restore data to the specified database instead of the database used when backing up
--redirect-schema schema	Restore data to the specified schema, not the schema used during backup
--run-analyze	Run ANALYZE on the recovered table
--timestamp timestamp	The timestamp required to be used during recovery, the format is YYYYMMDDHHMMSS
--truncate-table	Delete the recovered table data
--verbose	Print detailed log information
--version	Print the tool version number and exit
--with-globals	Recover global metadata
--with-stats	Recover statistics

3 Examples

Restore the backup of the timestamp in the /home/mxadmin/backup directory.

$ mxrestore --backup-dir /home/mxadmin/backup --timestamp 20210820143820

Recover the data backed up by mxbackup in S3 object store.

$ mxrestore --timestamp 20221208185654 --plugin-config /tmp/s3-config-file.yaml

Notes!
The log file directory of the mxbackup tool is <gpadmin_home>/gpAdminLogs/gpbackup_s3_plugin_timestamp.log, where the timestamp format is YYYMMDDHHMMSS.

Notes!
For more information about backup and recovery data, please see Backup and Restore. For the use of the S3 object storage plug-in in the mxbackup tool, please see mxbackup.