Important

You are viewing the archived documentation of TiDB, which no longer receives updates. It is recommended that you use the latest LTS version of the TiDB database.

tiup dm reload

After modifying the cluster configuration, the cluster needs to be reloaded using the tiup dm reload command for the configuration to take effect. This command publishes the configuration of the control machine to the remote machine where the service is running and restarts the service in order according to the upgrade process. The cluster remains available during the restart process.

Syntax

tiup dm reload <cluster-name> [flags]

<cluster-name>: the name of the cluster to operate on.

Options

-N, --node

Specifies the nodes to be restarted. If not specified, all nodes are restarted. The value of this option is a comma-separated list of node IDs. You can get the node IDs from the first column of the cluster status table returned by the tiup dm display command.
Data type: STRINGS
If this option is not specified in the command, all nodes are selected by default.

Note

If the -R, --role option is specified at the same time, only the service nodes that match both the specifications of -N, --node and -R, --role are restarted.
If the --skip-restart option is specified, the -N, --node option is invalid.

-R, --role

Specifies the roles to be restarted. If not specified, all roles are restarted. The value of this option is a comma-separated list of node roles. You can get the roles of nodes from the second column of the cluster status table returned by the tiup dm display command.
Data type: STRINGS
If this option is not specified in the command, all roles are selected by default.

Note

If the -N, --node option is specified at the same time, only the service nodes that match both the specifications of -N, --node and -R, --role are restarted.
If the --skip-restart option is specified, the -R, --role option is invalid.

--skip-restart

The tiup dm reload command performs two operations:

Refreshes all node configurations
Restarts the specified node

After you specify the --skip-restart option, it only refreshes the configuration without restarting any nodes, so that the refreshed configuration is not applied and does not take effect until the next restart of the corresponding service.

Data type: BOOLEAN
Default: false

-h, --help

Prints the help information.
Data type: BOOLEAN
Default: false

Output

The execution log of the tiup-dm.

<< Back to the previous page - TiUP DM command list

Download PDF