nodetool cleanup

Immediately cleans up keyspaces and tables that no longer belong to a node.

Immediate cleans up keyspaces and tables that no longer belong to a node.

OpsCenter provides a Cleanup option in the Nodes UI for .

DataStax Enterprise does not automatically remove data from nodes that lose part of their partition range to a newly added node. After adding a new node, use nodetool cleanup on the source node and on neighboring nodes that shared the same subrange to prevent the database from including the old data to rebalance the load on that node. nodetool cleanup temporarily increases disk space use proportional to the size of the largest SSTable and causes Disk I/O to occur.

Important: Failure to run nodetool cleanup after adding a node may result in data inconsistencies including resurrection of previously deleted data.

Synopsis

nodetool [connection_options] cleanup 
[-j num_jobs] [--] 
[keyspace_name table_name [table_name ...]]
Table 1. Legend
Syntax conventions Description
UPPERCASE Literal keyword.
Lowercase Not literal.
Italics Variable value. Replace with a valid option or user-defined value.
[ ] Optional. Square brackets ( [ ] ) surround optional command arguments. Do not type the square brackets.
( ) Group. Parentheses ( ( ) ) identify a group to choose from. Do not type the parentheses.
| Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
... Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.
'Literal string' Single quotation ( ' ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
{ key:value } Map collection. Braces ( { } ) enclose map collections or key value pairs. A colon separates the key and the value.
<datatype1,datatype2> Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
cql_statement; End CQL statement. A semicolon ( ; ) terminates all CQL statements.
[ -- ] Separate the command line options from the command arguments with two hyphens ( -- ). This syntax is useful when arguments might be mistaken for command line options.
' <schema> ... </schema> ' Search CQL only: Single quotation marks ( ' ) surround an entire XML schema declaration.
@xml_entity='xml_entity_type' Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.

Definition

The short form and long form parameters are comma-separated.

Connection options

-h, --host hostname
The hostname or IP address of a remote node or nodes. When omitted, the default is the local machine.
-p, --port jmx_port
The JMX port number.
-pw, --password jmxpassword
The JMX password for authenticating with secure JMX. If a password is not provided, you are prompted to enter one.
-pwf, --password-file jmx_password_filepath
The filepath to the file that stores JMX authentication credentials.
-u, --username jmx_username
The username for authenticating with secure JMX.

Command arguments

--
Separates an option from an argument that could be mistaken for a option.
-j, --jobs num_jobs
  • num_jobs - Number of SSTables affected simultaneously. Default: 2.
  • 0 - Use all available compaction threads.
keyspace_name
Keyspace name. By default, all keyspaces.
table_name
The table name.

Examples

Clean up all keyspaces with specified number of jobs

nodetool cleanup -j 1

Clean up single table

nodetool cleanup cycling cyclist_name