- About the nodetool utility
A command line interface for monitoring a cluster and performing routine database operations.
- nodetool abortrebuild
Aborts a running rebuild operation. Completes processing of active streams.
- nodetool assassinate
Forcefully removes a dead node without re-replicating any data. Use as a last resort when you cannot successfully use nodetool removenode.
- nodetool bootstrap
Monitors and manages the bootstrap process on one or more nodes.
- nodetool cfhistograms
This tool has been renamed to tablehistograms.
- nodetool cfstats
This tool has been renamed nodetool tablestats.
- nodetool cleanup
Triggers immediate cleanup of 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 or given SSTables.
- nodetool compactionhistory
Prints history of compaction.
- nodetool compactionstats
Prints statistics about compactions.
- nodetool decommission
Causes a live node to decommission itself, streaming its data to the next node on the ring to replicate appropriately.
- nodetool describecluster
Prints the name, snitch, partitioner and schema version of a cluster.
- nodetool describering
Shows the token ranges.
- nodetool disableautocompaction
Disables autocompaction for a keyspace and one or more tables.
- nodetool disablebackup
Disables incremental backup.
- nodetool disablebinary
Disables the native transport.
- nodetool disablegossip
Disables the gossip protocol.
- nodetool disablehandoff
Disables storing hinted handoffs.
- nodetool disablehintsfordc
Disables hints for a datacenter.
- nodetool drain
Drains the node.
- nodetool enableautocompaction
Enables autocompaction for a keyspace and one or more tables, or all tables.
- nodetool enablebackup
Enables incremental backup.
- nodetool enablebinary
Re-enables the native transport that defines the format of the binary messages.
- nodetool enablegossip
Re-enables gossip.
- nodetool enablehandoff
Reenables storing of future hints on the current node.
- nodetool enablehintsfordc
Turns on hints for a datacenter that was previously disabled with nodetool disablehintsfordc.
- nodetool failuredetector
Shows the failure detector information for the cluster.
- nodetool flush
Flushes one or more tables from the memtable to SSTables on disk.
- nodetool garbagecollect
Removes deleted data from one or more tables.
- nodetool gcstats
Prints garbage collection (GC) statistics.
- nodetool getbatchlogreplaythrottle
Prints batchlog replay throttle in KBs.
- 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 getcompactionthreshold
Prints minimum and maximum compaction thresholds for a given table.
- nodetool getcompactionthroughput
Prints the compaction throughput in megabytes (MBs) per second.
- nodetool getconcurrentcompactors
Gets the number of concurrent compactors in the system.
- nodetool getconcurrentviewbuilders
Display the number of concurrent materialized view builders.
- nodetool getendpoints
Prints the endpoints that own the partition key.
- nodetool gethintedhandoffthrottlekb
Gets the hinted handoff throttle in KB/sec per delivery thread.
- nodetool getinterdcstreamthroughput
Prints the outbound throttle (throughput cap) for all streaming file transfers between datacenters.
- nodetool getlogginglevels
Gets the runtime logging levels.
- nodetool getmaxhintwindow
Prints the maximum time that the database generates hints for an unresponsive node.
- nodetool getseeds
Gets the IP list of the current seed node.
- nodetool getsstables
Prints the SSTable that owns the partition key.
- nodetool getstreamthroughput
Gets the throughput throttle for streaming file transfers.
- nodetool gettimeout
Prints the current timeout values in milliseconds.
- nodetool gettraceprobability
Prints the current trace probability value.
- nodetool gossipinfo
Shows the gossip information to discover broadcast protocol between nodes in a cluster.
- nodetool handoffwindow
Prints current hinted handoff window.
- nodetool help
Displays nodetool command help.
- nodetool info
Prints node information, such as load and uptime.
- nodetool inmemorystatus
Returns a list of the in-memory tables and the amount of memory each table is using.
- nodetool invalidatecountercache
Resets global counter cache parameter to save all keys from the counter cache.
- nodetool invalidatekeycache
Clears the key cache.
- nodetool invalidaterowcache
Invalidates the row cache.
- nodetool join
Joins the node to the ring.
- nodetool listendpointspendinghints
Prints information about hints that the node has for other nodes.
- nodetool leaksdetection
Enables and configures memory leak tracking.
- nodetool listsnapshots
Lists snapshots, size on disk, and true size.
- nodetool mark_unrepaired
Marks all SSTables of a table or keyspace as unrepaired.
- nodetool move
Moves the node on the token ring to a new token.
- nodetool netstats
Prints network information about the host.
- nodetool nodesyncservice
Manage the NodeSync service on the connected node.
- nodetool pausehandoff
Pauses the hints delivery process.
- nodetool proxyhistograms
Provides a histogram of network operation statistics.
- nodetool rangekeysample
Shows the sampled keys held across all keyspaces.
- nodetool rebuild
Rebuilds data by streaming from other nodes.
- nodetool rebuild_index
Performs a full rebuild of native secondary indexes for a given 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 reloadseeds
Reloads the seed node list from the seed node provider.
- nodetool reloadtriggers
Reloads trigger classes.
- nodetool relocatesstables
Rewrites any SSTable to correct disk.
- nodetool removenode
Shows the status of current node removal; forces completion of pending removal, or removes identified node.
- nodetool repair
Repairs one or more tables in a cluster when all involved replicas are up and accessible..
- nodetool replaybatchlog
Kicks off batchlog replay and waits for finish.
- nodetool resetlocalschema
Drops the schema information of the local node and resynchronizes the schema from another node.
- nodetool resume
Restart a node's bootstrap process.
- nodetool resumehandoff
Resumes 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 setbatchlogreplaythrottle
Sets batchlog replay throttle in KB per second, or 0 to disable throttling.
- 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 setconcurrentviewbuilders
Sets the number of simultaneous materialized view builder tasks.
- 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 setmaxhintwindow
Sets the maximum time that the database generates hints for an unresponsive node.
- 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.
- nodetool snapshot
Creates a backup by taking a snapshot of table data.
- nodetool status
Provides information about the cluster, such as the state, load, and IDs.
- nodetool statusbackup
Provides status of incremental backup.
- nodetool statusbinary
Provides the status of native transport that defines the format of the binary message.
- nodetool statusgossip
Provides status of gossip.
- nodetool statushandoff
Provides status of storing future hints.
- nodetool stop
Stops compaction.
- nodetool stopdaemon
Stops 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.
- nodetool tpstats
Prints usage statistics of thread pools.
- nodetool truncatehints
Truncates all hints on the local node or for one or more endpoints.
- nodetool upgradesstables
Rewrites SSTables for tables that are not running the current version of DataStax Enterprise.
- nodetool verify
Checks the data checksum for one or more tables.
- nodetool version
Provides the DSE database version.
- nodetool viewbuildstatus
Shows the progress of a materialized view build.