nodetool

About the nodetool utility

A command line interface for monitoring a cluster and performing routine database operations.

nodetool abortrebuild

Abort a currently running rebuild operation. Completes processing of active streams, but no new streams are started.

nodetool assassinate

Forcefully removes a dead node without re-replicating any data. It is a last resort tool if you cannot successfully use nodetool removenode.

nodetool bootstrap

Monitor and manage a node’s bootstrap process.

nodetool cfhistograms

This tool has been renamed to tablehistograms.

nodetool cfstats

This tool has been renamed nodetool tablestats.

nodetool cleanup

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

nodetool clearsnapshot

Removes one or more snapshots.

nodetool compact

Forces a major compaction on one or more tables.

nodetool compactionhistory

Provides the history of compaction operations.

nodetool compactionstats

Provide statistics about a compaction.

nodetool decommission

Deactivates a node by streaming its data to another node.

nodetool describecluster

Provide the name, snitch, partitioner and schema version of a cluster.

nodetool describering

Provides the partition ranges of a keyspace.

nodetool disableautocompaction

Disables autocompaction for a keyspace and one or more tables on the current node only.

nodetool disablebackup

Disables incremental backup.

nodetool disablebinary

Disables the native transport.

nodetool disablegossip

Disables the gossip protocol.

nodetool disablehandoff

Disables storing of future hints on the current node.

nodetool disablehintsfordc

Disable hints for a datacenter.

nodetool disablethrift

Disables the Thrift server.

nodetool drain

Drains the node.

nodetool enableautocompaction

Enables autocompaction for a keyspace and one or more tables.

nodetool enablebackup

Enables incremental backup.

nodetool enablebinary

Re-enables native transport.

nodetool enablegossip

Re-enables gossip.

nodetool enablehandoff

Re-enables the storing of future hints on the current node.

nodetool enablehintsfordc

Enable hints for a datacenter.

nodetool enablethrift

Re-enables the Thrift server.

nodetool failuredetector

Shows the failure detector information for the cluster.

nodetool flush

Flushes one or more tables from the memtable.

nodetool garbagecollect

Remove deleted data from one or more tables.

nodetool getcachecapacity

Gets the global key, row, and counter cache capacities in megabytes.

nodetool getcachekeystosave

Gets the global number of keys saved by counter cache, key cache, and row cache.

nodetool gcstats

Print garbage collection (GC) statistics.

nodetool getcompactionthreshold

Provides the minimum and maximum compaction thresholds in megabytes for a table.

nodetool getcompactionthroughput

Print the throughput cap in megabytes (MB) per second for compaction in the system.

nodetool getconcurrentcompactors

Get the number of concurrent compactors in the system.

nodetool getendpoints

Provides the IP addresses or names of replicas that own the partition key.

nodetool getinterdcstreamthroughput

Prints the throughput cap in Megabits per second (Mbps) for inter-datacenter streaming.

nodetool getlogginglevels

Get the runtime logging levels.

nodetool getseeds

Refreshes the IP address of the seed node currently in use, as listed by the seed provider.

nodetool getsstables

Provides the SSTables that own the partition key.

nodetool getstreamthroughput

Provides the Mb per second outbound throughput limit for streaming in the system.

nodetool gettimeout

Print the timeout value of the given type in milliseconds.

nodetool gettraceprobability

Get the probability for tracing a request.

nodetool gossipinfo

Provides the gossip information for the cluster.

nodetool help

Provides nodetool command help.

nodetool gethintedhandoffthrottlekb

Gets the hinted handoff throttle in KB/sec per delivery thread.

nodetool info

Provides node information, such as load and uptime.

nodetool invalidatecountercache

Clears the counter cache.

nodetool invalidatekeycache

Clears the key cache.

nodetool invalidaterowcache

Invalidates the row cache.

nodetool join

Causes the node to join the ring.

nodetool listendpointspendinghints

Prints information about hints that the node has for other nodes.

nodetool listsnapshots

Lists snapshot names, size on disk, and true size.

nodetool mark_unrepaired

Mark all target SSTables as unrepaired.

nodetool move

Moves the node on the token ring to a new token.

nodetool netstats

Provides network information about the host.

nodetool pausehandoff

Pauses the hints delivery process.

nodetool proxyhistograms

Provides a histogram of network statistics.

nodetool rangekeysample

Provides the sampled keys held across all keyspaces.

nodetool rebuild

Rebuilds data on a node by streaming from another datacenter.

nodetool rebuild_index

Performs a full rebuild of the index for a table.

nodetool rebuild_view

Performs a rebuild of the specified materialized views for a particular table for local data.

nodetool refresh

Loads newly placed SSTables onto the system without a restart.

nodetool refreshsizeestimates

Refresh system.size_estimates table.

nodetool reloadlocalschema

Reload local node schema from system tables.

nodetool reloadtriggers

Reloads trigger classes.

nodetool reloadseeds

Reloads the seed node list from the seed node provider.

nodetool relocatesstables

Rewrites any SSTable that contains tokens that should be in another data directory.

nodetool removenode

Provides the status of current node removal, forces completion of pending removal, or removes the identified node.

nodetool repair

Repairs one or more tables.

nodetool replaybatchlog

Replay batchlog and wait for finish.

nodetool resetlocalschema

Reset the node’s local schema and resynchronizes.

nodetool resume

Restart a node’s bootstrap process.

nodetool resumehandoff

Resume hints delivery process.

nodetool ring

Provides node status and information about the ring.

nodetool scrub

Rebuilds SSTables for one or more tables.

nodetool sequence

Run multiple nodetool commands from a file, resource, or standard input (StdIn) sequentially.

nodetool setcachecapacity

Sets global key, row, and counter cache capacities in megabytes.

nodetool setcachekeystosave

Sets the global number of keys saved by each cache for faster post-restart warmup.

nodetool setcompactionthreshold

Sets minimum and maximum compaction thresholds for a table.

nodetool setcompactionthroughput

Sets the throughput capacity for compaction in the system, or disables throttling.

nodetool setconcurrentcompactors

Sets number of concurrent compactors.

nodetool sethintedhandoffthrottlekb

Sets hinted handoff throttle in KB/sec per delivery thread.

nodetool setinterdcstreamthroughput

Sets the inter-datacenter throughput capacity in megabits per second (Mbps) streaming.

nodetool setlogginglevel

Sets the log level threshold for a given component or class.

nodetool setstreamthroughput

Sets the throughput capacity in megabits per second (Mb/s) for outbound streaming in the system.

nodetool settimeout

Temporarily sets the timeout for the given timeout type.

nodetool settraceprobability

Sets the probability for tracing a request.

nodetool sjk

Runs Swiss Java Knife (SJK) commands to execute, troubleshoot, and monitor the database using MBeans.

nodetool snapshot

Backs up data and table schemas.

nodetool status

Provide information about the cluster, such as the state, load, and IDs.

nodetool statusbackup

Provide the status of backup.

nodetool statusbinary

Provide the status of native transport.

nodetool statusgossip

Provide the status of gossip.

nodetool statushandoff

Provides the status of hinted handoff.

nodetool statusthrift

Provide the status of the Thrift server.

nodetool stop

Stops the compaction process.

nodetool stopdaemon

Stops the cassandra daemon.

nodetool tablehistograms

Provides current performance metrics for read and write operations during the past fifteen minutes.

nodetool tablestats

Provides statistics about one or more tables.

nodetool toppartitions

Samples database reads and writes and reports the most active partitions in a specified table.

nodetool tpstats

Provides usage statistics of thread pools.

nodetool truncatehints

Truncates all hints on the local node, or truncates hints for the one or more endpoints.

nodetool upgradesstables

Rewrites SSTables for tables that are not running the current version of DataStax Enterprise.

nodetool verify

Verify (check data checksum for) one or more tables.

nodetool version

Provides the version number of Cassandra running on the specified node.

nodetool viewbuildstatus

Shows the progress of a materialized view build.

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com