diff --git a/gpdb-doc/dita/utility_guide/admin_utilities/gprecoverseg.xml b/gpdb-doc/dita/utility_guide/admin_utilities/gprecoverseg.xml index 7a17b40fa0f99ab8bbde13cee9ca27436b523791..5dd4b63030a0298045507b5561025cb23b2e6eb1 100644 --- a/gpdb-doc/dita/utility_guide/admin_utilities/gprecoverseg.xml +++ b/gpdb-doc/dita/utility_guide/admin_utilities/gprecoverseg.xml @@ -9,14 +9,15 @@
Synopsis gprecoverseg [-p new_recover_host[,...]] | -i recover_config_file] [-d master_data_directory] - [-B parallel_processes] [-F] [-a] [-q] [-l logfile_directory] + [-B parallel_processes] [-F [-s]] [-a] [-q] + [--no-progress] [-l logfile_directory] gprecoverseg -r gprecoverseg -o output_recover_config_file              [-p new_recover_host[,...]] -gprecoverseg -? +gprecoverseg -? | --help gprecoverseg --version
@@ -105,6 +106,15 @@ instance before copying the data from the active (current primary) segment instance. Before performing a full recovery, ensure that the segment failure did not cause data corruption and that any host segment disk issues have been fixed. + Full recovery can take a long time for large databases, so + gprecoverseg displays a running estimate of the completion progress + of the copy for each segment. Progress for each segment is updated once per second, + using ANSI escape codes to update the line for each segment in-place. If you are + redirecting the gprecoverseg output to a file, or if the ANSI escape + codes do not work correctly on your terminal, you can include the -s + option on the command line to omit the ANSI escape codes. This outputs a new line once + per second for each segment. Include the --no-progress option to + completely disable the progress reports. -i recover_config_file @@ -169,6 +179,17 @@ newPort:newDataDirectory synchronized before running gprecoverseg -r. If there are any in progress queries, they will be cancelled and rolled back. + + -s + Show pg_basebackup progress sequentially instead of in-place. Useful + when writing to a file, or if a tty does not support escape sequences. The default is to + show progress in-place. + + + --no-progress + Suppresses progress reports from the pg_basebackup utility. The + default is to display progress of base backups. + -v (verbose) Sets logging output to verbose.