docs/operating-scylla/nodetool.rst
.. toctree:: :maxdepth: 1 :hidden:
nodetool-commands/backup nodetool-commands/cfhistograms nodetool-commands/cfstats nodetool-commands/checkandrepaircdcstreams nodetool-commands/cleanup nodetool-commands/clearsnapshot nodetool-commands/cluster/index nodetool-commands/compact nodetool-commands/compactionhistory nodetool-commands/compactionstats nodetool-commands/decommission nodetool-commands/describecluster nodetool-commands/describering nodetool-commands/disableautocompaction nodetool-commands/disablebackup nodetool-commands/disablebinary nodetool-commands/disablegossip nodetool-commands/drain nodetool-commands/dropquarantinedsstables nodetool-commands/enableautocompaction nodetool-commands/enablebackup nodetool-commands/enablebinary nodetool-commands/enablegossip nodetool-commands/excludenode nodetool-commands/flush nodetool-commands/getcompactionthroughput nodetool-commands/getendpoints nodetool-commands/getsstables nodetool-commands/getstreamthroughput nodetool-commands/gettraceprobability nodetool-commands/gossipinfo nodetool-commands/help nodetool-commands/info nodetool-commands/listsnapshots nodetool-commands/proxyhistograms nodetool-commands/rebuild nodetool-commands/refresh nodetool-commands/removenode nodetool-commands/repair nodetool-commands/resetlocalschema nodetool-commands/restore nodetool-commands/ring nodetool-commands/scrub nodetool-commands/setcompactionthroughput nodetool-commands/setlogginglevel nodetool-commands/setstreamthroughput nodetool-commands/settraceprobability nodetool-commands/snapshot nodetool-commands/sstableinfo nodetool-commands/status nodetool-commands/statusbackup nodetool-commands/statusbinary nodetool-commands/statusgossip Nodetool stop compaction <nodetool-commands/stop> nodetool-commands/tablestats nodetool-commands/tasks/index nodetool-commands/toppartitions nodetool-commands/upgradesstables nodetool-commands/version nodetool-commands/viewbuildstatus
The nodetool utility provides a simple command-line interface to the following exposed operations and attributes.
.. _nodetool-generic-options:
-p <port> or --port <port> - The port of the REST API of the ScyllaDB node.-- - Separates command-line options from the list of argument(useful when an argument might be mistaken for a command-line option).Operations that are not listed below are currently not available.
backup <nodetool-commands/backup/> - Copy SSTables from a specified keyspace's snapshot to a designated bucket in object storage.cfhistograms <nodetool-commands/cfhistograms/> - Provides statistics about a table, including number of SSTables, read/write latency, partition size and column count.cfstats </operating-scylla/nodetool-commands/cfstats/> - Provides in-depth diagnostics regard table.checkandrepaircdcstreams </operating-scylla/nodetool-commands/checkandrepaircdcstreams/> - Checks and fixes CDC streams.cleanup </operating-scylla/nodetool-commands/cleanup/> - Triggers the immediate cleanup of keys no longer belonging to a node.clearsnapshot </operating-scylla/nodetool-commands/clearsnapshot/> - This command removes snapshots.cluster <nodetool-commands/cluster/index> - Run a cluster operation.compact </operating-scylla/nodetool-commands/compact/>- Force a (major) compaction on one or more column families.compactionhistory </operating-scylla/nodetool-commands/compactionhistory/> - Provides the history of compactions.compactionstats </operating-scylla/nodetool-commands/compactionstats/>- Print statistics on compactions.decommission </operating-scylla/nodetool-commands/decommission/> - Decommission the node.describecluster </operating-scylla/nodetool-commands/describecluster/> - Print the name, snitch, partitioner and schema version of a cluster.describering </operating-scylla/nodetool-commands/describering/> - :code:<keyspace>- Shows the partition ranges of a given keyspace.disableautocompaction </operating-scylla/nodetool-commands/disableautocompaction/> - Disable automatic compaction of a keyspace or table.disablebackup </operating-scylla/nodetool-commands/disablebackup/> - Disable incremental backup.disablebinary </operating-scylla/nodetool-commands/disablebinary/> - Disable native transport (binary protocol).disablegossip </operating-scylla/nodetool-commands/disablegossip/> - Disable gossip (effectively marking the node down).drain </operating-scylla/nodetool-commands/drain/> - Drain the node (stop accepting writes and flush all column families).dropquarantinedsstables </operating-scylla/nodetool-commands/dropquarantinedsstables> :code:<keyspace> :code:<table> Drop quarantined SSTables from the specified keyspace and table(s), or from all keyspaces if no keyspace is specified.enableautocompaction </operating-scylla/nodetool-commands/enableautocompaction/> - Enable automatic compaction of a keyspace or table.enablebackup </operating-scylla/nodetool-commands/enablebackup/> - Enable incremental backup.enablebinary </operating-scylla/nodetool-commands/enablebinary/> - Re-enable native transport (binary protocol).enablegossip </operating-scylla/nodetool-commands/enablegossip/> - Re-enable gossip.excludenode </operating-scylla/nodetool-commands/excludenode/>- Mark nodes as permanently down.flush </operating-scylla/nodetool-commands/flush/> - Flush one or more column families.getcompactionthroughput </operating-scylla/nodetool-commands/getcompactionthroughput> - Print the throughput cap for compaction in the systemgetendpoints <nodetool-commands/getendpoints/> :code:<keyspace> :code:<table> :code:<key>- Print the end points that owns the key.getsstables </operating-scylla/nodetool-commands/getsstables> - Print the sstable filenames that own the key.getstreamthroughput </operating-scylla/nodetool-commands/getstreamthroughput> - Print the throughput cap for SSTables streaming in the systemgettraceprobability </operating-scylla/nodetool-commands/gettraceprobability> - Displays the current trace probability value. 0 is disabled 1 is enabled.gossipinfo </operating-scylla/nodetool-commands/gossipinfo/> - Shows the gossip information for the cluster.help </operating-scylla/nodetool-commands/help/> - Display list of available nodetool commands.info </operating-scylla/nodetool-commands/info/> - Print node informationlistsnapshots </operating-scylla/nodetool-commands/listsnapshots/> - Lists all the snapshots along with the size on disk and true size.<new token>- Move node on the token ring to a new tokenproxyhistograms </operating-scylla/nodetool-commands/proxyhistograms/> - Print statistic histograms for network operationsrebuild </operating-scylla/nodetool-commands/rebuild/> :code:[<src-dc-name>]- Rebuild data by streaming from other nodesrefresh </operating-scylla/nodetool-commands/refresh/>- Load newly placed SSTables to the system without restartremovenode </operating-scylla/nodetool-commands/removenode/>- Remove node with the provided IDrepair <nodetool-commands/repair/> :code:<keyspace> :code:<table> - Repair one or more vnode tables.resetlocalschema </operating-scylla/nodetool-commands/resetlocalschema/> - Reset the node's local schema.restore </operating-scylla/nodetool-commands/restore/> - Load SSTables from a designated bucket in object store into a specified keyspace or tablering <nodetool-commands/ring/> - The nodetool ring command display the token ring information.scrub </operating-scylla/nodetool-commands/scrub> :code:[-m mode] [--no-snapshot] <keyspace> [<table>...] - Scrub the SSTable files in the specified keyspace or table(s)setcompactionthroughput </operating-scylla/nodetool-commands/setcompactionthroughput> - Set the throughput cap for compaction in the systemsetlogginglevel</operating-scylla/nodetool-commands/setlogginglevel> - sets the logging level threshold for ScyllaDB classessetstreamthroughput </operating-scylla/nodetool-commands/setstreamthroughput> - Set the throughput cap for SSTables streaming in the systemsettraceprobability </operating-scylla/nodetool-commands/settraceprobability/> <value> - Sets the probability for tracing a request. race probability valuesnapshot </operating-scylla/nodetool-commands/snapshot> :code:[-t tag] [-cf column_family] <keyspace> - Take a snapshot of specified keyspaces or a snapshot of the specified table.sstableinfo </operating-scylla/nodetool-commands/sstableinfo> - Get information about sstables per keyspace/table.status </operating-scylla/nodetool-commands/status/> - Print cluster information.statusbackup </operating-scylla/nodetool-commands/statusbackup/> - Status of incremental backup.statusbinary </operating-scylla/nodetool-commands/statusbinary/> - Status of native transport (binary protocol).statusgossip </operating-scylla/nodetool-commands/statusgossip/> - Status of gossip.stop </operating-scylla/nodetool-commands/stop/> - Stop compaction operation.cfhistograms <nodetool-commands/cfhistograms/>tablestats </operating-scylla/nodetool-commands/tablestats/> - Provides in-depth diagnostics regard table.tasks </operating-scylla/nodetool-commands/tasks/index> - Manage tasks manager tasks.toppartitions </operating-scylla/nodetool-commands/toppartitions/> - Samples cluster writes and reads and reports the most active partitions in a specified table and time frame.upgradesstables </operating-scylla/nodetool-commands/upgradesstables> - Upgrades each table that is not running the latest ScyllaDB version, by rewriting SSTables.version </operating-scylla/nodetool-commands/version> - Print the DB version.viewbuildstatus </operating-scylla/nodetool-commands/viewbuildstatus/> - Shows the progress of a materialized view build.