功能

help命令用于提供Roach工具支持的命令的帮助信息。

命令格式

python GaussRoach.py
--help | -h

参数说明

无

使用指南

无

命令示例

查看Roach工具的帮助信息。

python GaussRoach.py --help

系统回显

python GaussRoach.py --help
GaussRoach.py is a utility to backup FusionInsight GaussDB 200 to disk, NBU or OBS and restore FusionInsight GaussDB 200 from disk, NBU or OBS.
Usage:
  python GaussRoach.py -h | --help
  python GaussRoach.py -v | --version
  python GaussRoach.py -t config [-f confFile] [-c confFile] [-p] [--archive ARCHIVEMODE] [--logging-path filepath] [--cluster-timeout timeout]
  python GaussRoach.py -t clean [-D] [--logging-path filepath][--restore-new-cluster] [--cluster-timeout timeout]
  python GaussRoach.py -t start [--logging-path filepath] [--parallel-jobs] [--restore-new-cluster -X CONFIGXMLPATH ] [--cluster-timeout timeout] [--standby-build-timeout timeout]
  python GaussRoach.py -t backup [options]
  python GaussRoach.py -t restore [options]
  python GaussRoach.py -t stop [-F] [--stop-timeout] [--logging-path filepath]
  python GaussRoach.py -t delete [options]
  python GaussRoach.py -t backup [--tablename tablename] [options]
  python GaussRoach.py -t restore [--tablename tablename] [options]
  python GaussRoach.py -t show [options]
  python GaussRoach.py -t validate [options]
  python GaussRoach.py -t generate [options]
  python GaussRoach.py -t genstack
  python GaussRoach.py -t getobject [options]
  Common options:
  -t                                            The operation for GaussRoach followed by backup, clean, config, delete, generate, genstack, restore, show, start, stop and validate.
  -h  --help                                    Show this help, then exit.
  -v  --version                                 Display the current roach version.
  --master-port <master port>                   The port in which master roach should be started.
  --media-type <media type>                     Mention type of media either disk, NBU or OBS.
  --media-destination <media destination>       The path or policy that should be used for backup/restore as per media-type.
  --buffer-size <size>                          The buffer size that should be used.
  --buffer-block-size<size>                     The buffer block size that should be used.
  --parallel-process <count>                    The number of process that should be used.
  --logging-level <logging level>               [FATAL|ERROR|WARNING|INFO|DEBUG|DEBUG2]. Default logging level is warning.
  --logging                                     Enable logging into log file, will be disabled by default. This will be deprecated in future release. Use --enable-logging instead.
  --enable-logging <True/False>                 Enable logging into log file. Default is False.
  --log-filesize <size>                         The maximum log file size.
  --log-filecount <count>                       The maximum number of log files that should be created.
  --logging-path  <path-name>                   The location where log files must be created.
  --verbose                                     Gives details about the command being executed.
  --failure-retry-count <count>                 The number of times it should retry in case of failure.
  --retry-wait-time     <time>                  Time it should wait before retrying after failure.
  --cpu-relinquish-time <time>                  CPU is relinquished for the specified relinquish time. Relinquish time in seconds.
  --cpu-relinquish-size <size>                  CPU is relinquished after processing the relinquish size.
  --metadata-destination <path-name>            The path where the metadata file is to be kept in backup.
  --metadata-file-wait-time <time>              Wait time for reading metadata file.
  --max-memory-usage <value>                    Maximum allowed memory usage (in GB) for Roach process. Range 2-256.
  --pre-disk-space                              Checks availability of Disk Space before Backup and Restore.
  --resource-retry-count                        The number of times it should retry for library APIs like fopen, pthread.
  --master-ip                                   The ip on which master roach should be started.
  --obs-server-ip <address>                     OBS server ip address or domain name address.
  --bucket-name <bucketname>                    OBS bucket name.
  --cluster-unique-id <value>                   Used to indicate the unique identifier of the cluster.
Options for config
  -f                                            The path of gs_roach config file that will be distributed to every host.
  -c                                            The path of gs_roach template config file that will be created.
  -p                                            Config environment parameter and archive GUC parameter.
  --archive  <true/false>                       Decide whether start archive or stop archive. Default is true.
Options for start
  -X                                            The path of the Config XML file used for cluster setup.
  --logging-path                                The location where log files must be created.
  --parallel-jobs                               The number of parallel jobs to be performed for complete sync of standby data nodes from primary data nodes.
  --restore-new-cluster                         To perform start for restore data to new cluster.
  --cluster-timeout                             The timeout value for cm_ctl start/stop.
  --standby-build-timeout                       The timeout value for standby instance build.
Options for clean
  --logging-path                                The location where log files must be created.
  --restore-new-cluster                         To perform clean for restore data to new cluster.
  --cluster-timeout                             The timeout value for cm_ctl start/stop.
Options for backup
  -r  --conf-location <path-name>               Path for the gs_roach.conf file.
  -d  --dbname <dbname>                         The name of the database.
  -U  --username <username>                     User name for the cluster.
  --compression-level <level>                   The compression level that should be used for backup.
  --filesplit-size <size>                       Approximate file size after which the file will be split.
  --contrib-config <configFile>                 Path of config file having contrib module info (eg, for HDFS).
  --validation-type <value>                     Validate the contents of backup. Values "partial" or "full".
  --prior-backup-key                            Previous full/incremental backup key to be considered as the base for incremental backup.
  --validate-prior-backups <value>              Validate all prior backups (if any). One of the two values i.e. "Force" (mandatorily run validate), "Optimistic" (if not validated, it will run validate).
  --reader-thread-count                         Number of reader threads for processing.
  --reader-thread-file-count                    Number of buffer files for each reader thread.
  --reader-thread-file-size                     Buffer file size for each buffer file of reader thread.
  --table-list <file-name>                      Absolute path of input file name which contains list of tables(separated by new line) to be backed up. Each line contains the format <schema name>.TableName. Default schema is 'public'.
Options for table backup and table restore
  --tablename  <table name>                     Table name for the backup.
  --agent-port <agent port>                     The port in which master roach should be started for performing table restore.
Option for table restore
  --getdata-waittime-afterthreshold <time>      Wait time after buffer threshold.
  --clean                                       For Table restore, clean table data before performing restore.
  --continue                                    Continue table restore on failure.
  --create                                      Create table before performing table restore.
  --agent-port <agent port>                     The port in which master roach should be started for performing table restore.
Options for Restore
  --restore-buffer-threshold <buffer-threshold> The percentage of buffer that should be available before restoring the next file.
  --backup-key <backup key>                     The key used for restore.
  --clean                                       For cluster restore, performs clean up activity internally.
  --restore-new-cluster                         Restore data to new cluster.
  --restore-configs                             Few config files are restored from backup with changed values for IP, Port, Hostname and Path from current cluster.
  --validation-type <value>                     Validate the backup before doing restore. Values "partial" or "full".
  --contrib-config                              Path of config file having contrib module info (eg, for HDFS).
  --restore-target-time                         Time(<=) to be used for restore, format '<YYYY-MM-DD HH:MM:SS>'.
  --table-list <file-name>                      Absolute path of input file name which contains list of tables(separated by new line) to be restored from DB backup.
  --dbname <db-name>                            To restore database to a specified db name.
Options for Show
  --all-backups                                 Show complete backup catalogue information. Default action if no option given.
  --backup-key <backup_key>                     Show restore path up to a given backup key.
  --output-file <file path>                     Absolute file path with filename, where output of the show operation will be stored.
  --no-display                                  To suppress the output on console, and redirect to the output file silently.
  --overwrite                                   To overwrite the existing file.
  --related-backup-keys                         To show all related backups of the provided backup key.
  --restore-target-time                         To show backups from specified time(<=), format '<YYYY-MM-DD HH:MM:SS>'.
Options for Stop
  -F                                            Forcefully stop the backup operation.
  --stop-timeout                                Time after which the stop operation will exit.
Options for Validate
  [options]                                     Similar options as 'restore'...
Options for Generate
  --backup-topology                             Currently only the value "xml" supported, anything else will give error.
  --output-file                                 File path for output (Topology) XML file. The dir should be existing and writeable. This is an
                                                Optional parameter, if not specified it will be considered as "$PWD/clusterTopology_<BKUP_KEY>.xml".
  --media-type <media type>                     Optional parameter, by default type is "DISK", specifying "NBU" type will report an error (it is not supported).
  --media-destination <media destination>       The path for the disk backup used to generate the Topology XML.
  --generate-force                              Optional parameter, to forcefully overwrite the output file if it already exists.
Options for Delete
  --cascade                                     To delete all descendant backups of the provided backup key.
Options for Getobject
  --restore-count                               To get the number of recovery executions.
### Refer user manual for more details ###

相关命令

无