获取帮助

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

  1. gs_xtuner --help

输出帮助信息结果如下：

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