获取帮助
启动调优程序之前,可以通过如下命令获取帮助信息:
gs_dbmind component xtuner --help
输出帮助信息结果如下:
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]
{train,tune,recommend}
X-Tuner: a self-tuning tool integrated by openGauss.
positional arguments:
{train,tune,recommend}
Train a reinforcement learning model or tune database by model. And also can recommend best_knobs according to your workload.
optional arguments:
-h, --help show this help message and exit
-f DB_CONFIG_FILE, --db-config-file DB_CONFIG_FILE
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.
-x TUNER_CONFIG_FILE, --tuner-config-file TUNER_CONFIG_FILE
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.
-v, --version show program's version number and exit
Database Connection Information:
--database DATABASE, --db-name DATABASE
The name of database where your workload running on.
--db-user DB_USER Use this user to login your database. Note that the user must have sufficient permissions.
--db-port DB_PORT, --port DB_PORT
Use this port to connect with the database.
--db-host DB_HOST, --host DB_HOST
The IP address of your database InstallationGuide host.
--host-user HOST_USER
The login user of your database InstallationGuide host.
--host-ssh-port HOST_SSH_PORT
The SSH port of your database InstallationGuide host.
意见反馈