获取帮助

启动调优程序之前，可以通过如下命令获取帮助信息：

  1. gs_dbmind component xtuner --help

输出帮助信息结果如下：

  1. usage:  [-h] [--database DATABASE] [--db-user DB_USER] [--db-port DB_PORT] [--db-host DB_HOST] [--host-user HOST_USER] [--host-ssh-port HOST_SSH_PORT] [-f DB_CONFIG_FILE] [-x TUNER_CONFIG_FILE] [-v]
  2.         {train,tune,recommend}
  4. X-Tuner: a self-tuning tool integrated by openGauss.
  6. positional arguments:
  7.   {train,tune,recommend}
  8.                         Train a reinforcement learning model or tune database by model. And also can recommend best_knobs according to your workload.
  10. optional arguments:
  11.   -h, --help            show this help message and exit
  12.   -f DB_CONFIG_FILE, --db-config-file DB_CONFIG_FILE
  13.                         You can pass a path of configuration file otherwise you should enter database information by command arguments manually. Please see the template file share/server.json.template.
  14.   -x TUNER_CONFIG_FILE, --tuner-config-file TUNER_CONFIG_FILE
  15.                         This is the path of the core configuration file of the X-Tuner. You can specify the path of the new configuration file. The default path is /path/to/config/file. You can modify the configuration file to control the tuning process.
  16.   -v, --version         show program's version number and exit
  18. Database Connection Information:
  19.   --database DATABASE, --db-name DATABASE
  20.                         The name of database where your workload running on.
  21.   --db-user DB_USER     Use this user to login your database. Note that the user must have sufficient permissions.
  22.   --db-port DB_PORT, --port DB_PORT
  23.                         Use this port to connect with the database.
  24.   --db-host DB_HOST, --host DB_HOST
  25.                         The IP address of your database installation host.
  26.   --host-user HOST_USER
  27.                         The login user of your database installation host.
  28.   --host-ssh-port HOST_SSH_PORT
  29.                         The SSH port of your database installation host.