nodetool garbagecollect

Removes deleted data from one or more tables.

Note: The nodetool garbagecollect command is not the same as the Perform GC option in OpsCenter.

Synopsis

nodetool [connection_options] garbagecollect 
[-g ROW|CELL] [-j job_threads] [--]
[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 user name for authenticating with secure JMX.

Command arguments

--

Separates an option from an argument that could be mistaken for a option.

-g, --granularity ROW|CELL

ROW (default) removes deleted partitions and rows.
CELL also removes overwritten or deleted cells.

-j, --jobs num_jobs

num_jobs - Number of SSTables affected simultaneously. Default: 2.
0 - Use all available compaction threads.

keyspace_name

The keyspace name.

table_name

One or more table names, separated by a space.

Examples

To remove deleted data from all tables and keyspaces at the default granularity

nodetool garbagecollect

To remove deleted data from all tables and keyspaces, including overwritten or deleted cells

nodetool garbagecollect -g CELL