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 cluster clean

In the test environment, sometimes you might need to reset the cluster back to the state as it has been just deployed, which means deleting all data. You can do that easily using the tiup cluster clean command. After running it, the cluster is stopped and then cluster data is deleted. After restarting the cluster manually, you will get a clean cluster.

Warning

This command will first stop the cluster even if you choose only to clean up logs. Therefore, do not use it in a production environment.

Syntax

tiup cluster clean <cluster-name> [flags]

<cluster-name> is the cluster to clean.

Options

--all

Cleans data and the log at the same time. It is equivalent to specifying --data and --log at the same time.
Data type: BOOLEAN
This option is disabled by default and its default value is false. To enable this option, you can add this option to the command, and pass the true value or do not pass any value.
If it is not specified, you must specify at lease one of the following options:
- --data: Cleans data
- --log: Cleans the log

--data

Cleans data. If neither of it nor --all is specified, data will not be cleaned.
Data type: BOOLEAN
This option is disabled by default and its default value is false. To enable this option, you can add this option to the command, and pass the true value or do not pass any value.

--log

Cleans the log. If neither of it nor --all is specified, the log will not be cleaned.
Data type: BOOLEAN
This option is disabled by default and its default value is false. To enable this option, you can add this option to the command, and pass the true value or do not pass any value.

--ignore-node

Specifies the node that does not need cleaning. To specify multiple nodes, you can use this option multiple times. For example, --ignore-node <node-A> --ignore-node <node-B>.
Data type: StringArray
Default: empty

--ignore-role

Specifies the role that does not need cleaning. To specify multiple roles, you can use this option multiple times. For example, --ignore-role <role-A> --ignore-role <role-B>.
Data type: StringArray
Default: empty

-h, --help

Prints help information.
Data type: BOOLEAN
This option is disabled by default and its default value is false. To enable this option, you can add this option to the command, and pass the true value or do not pass any value.

Output

The execution logs of tiup-cluster.

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

Download PDF