HOME
ACADEMY
DOCS
CONTACT US
DOWNLOAD DATASTAX
GLOSSARY
SUPPORT
DEVELOPER BLOGS
This document is
no longer maintained
.
Apache Cassandra 3.0 for DSE 5.0
About Apache Cassandra
What's new?
Understanding the architecture
Architecture in brief
Internode communications (gossip)
Failure detection and recovery
Data distribution and replication
Consistent hashing
Virtual nodes
Data replication
Partitioners
Murmur3Partitioner
RandomPartitioner
ByteOrderedPartitioner
Snitches
Dynamic snitching
SimpleSnitch
RackInferringSnitch
PropertyFileSnitch
GossipingPropertyFileSnitch
Ec2Snitch
Ec2MultiRegionSnitch
GoogleCloudSnitch
CloudstackSnitch
Database internals
Storage engine
How Cassandra reads and writes data
How is data written?
How is data maintained?
How is data updated?
How is data deleted?
How are indexes stored and updated?
How is data read?
How do write patterns affect reads?
Data consistency
How are consistent read and write operations handled?
How are Cassandra transactions different from RDBMS transactions?
How do I accomplish lightweight transactions with linearizable consistency?
How do I discover consistency level performance?
How is the consistency level configured?
How is the serial consistency level configured?
How are read requests accomplished?
How are write requests accomplished?
Planning a cluster deployment
Installing
Using the Yum repository
Using the APT repository
Installing from the binary tarball
Installing earlier releases
Uninstalling Cassandra
Installing on cloud providers
Installing the JDK
Installing Oracle JDK on RHEL-based Systems
Installing Oracle JDK on Debian-based systems
Installing OpenJDK on RHEL-based systems
Installing OpenJDK on Debian-based systems
Recommended production settings
Install locations
Tarball installation directories
Package installation directories
Configuration
cassandra.yaml
Cassandra include file
Security
Securing Cassandra
Internal authentication
Internal authorization
JMX authentication and authorization
SSL encryption
Configuring firewall port access
Configuring gossip settings
Configuring the heap dump directory
Configuring virtual nodes
Enabling virtual nodes on a new cluster
Enabling virtual nodes on an existing production cluster
Using multiple network interfaces
Configuring logging
Commit log archive configuration
Generating tokens
Hadoop support
Initializing a cluster
Initializing a multiple node cluster (single datacenter)
Initializing a multiple node cluster (multiple datacenters)
Starting and stopping Cassandra
Starting Cassandra as a service
Starting Cassandra as a stand-alone process
Stopping Cassandra as a service
Stopping Cassandra as a stand-alone process
Clearing the data as a service
Clearing the data as a stand-alone process
Operations
Adding or removing nodes, datacenters, or clusters
Adding nodes to an existing cluster
Adding a datacenter to a cluster
Replacing a dead node or dead seed node
Replacing a running node
Moving a node from one rack to another
Decommissioning a datacenter
Removing a node
Switching snitches
Changing keyspace replication strategy
Edge cases for transitioning or migrating a cluster
Adding single-token nodes to a cluster
Adding a datacenter to a single-token architecture cluster
Replacing a dead node in a single-architecture cluster
Backing up and restoring data
About snapshots
Taking a snapshot
Deleting snapshot files
Enabling incremental backups
Restoring from a snapshot
Restoring a snapshot into a new cluster
Recovering from a single disk failure using JBOD
Repairing nodes
Hinted Handoff: repair during write path
Read Repair: repair during read path
Manual repair: Anti-entropy repair
Changing repair strategies
Monitoring Cassandra
Getting statistics and metrics
Table statistics
Thread pool and read/write latency statistics
Compaction metrics
Tuning Java resources
Data caching
Configuring data caches
Monitoring and adjusting caching
Configuring memtable thresholds
Configuring compaction
Compression
When to compress data
Configuring compression
Testing compaction and compression
Tuning Bloom filters
Moving data to or from other databases
Purging gossip state on a node
Cassandra tools
The nodetool utility
About the nodetool utility
abortrebuild
assassinate
bootstrap
cfhistograms
cfstats
cleanup
clearsnapshot
compact
compactionhistory
compactionstats
decommission
describecluster
describering
disableautocompaction
disablebackup
disablebinary
disablegossip
disablehandoff
disablehintsfordc
disablethrift
drain
enableautocompaction
enablebackup
enablebinary
enablegossip
enablehandoff
enablehintsfordc
enablethrift
failuredetector
flush
gcstats
getcompactionthreshold
getcompactionthroughput
getendpoints
getinterdcstreamthroughput
getlogginglevels
getseeds
getsstables
getstreamthroughput
gettimeout
gettraceprobability
gossipinfo
help
info
invalidatecountercache
invalidatekeycache
invalidaterowcache
join
listendpointspendinghints
listsnapshots
mark_unrepaired
move
netstats
pausehandoff
proxyhistograms
rangekeysample
rebuild
rebuild_index
refresh
refreshsizeestimates
reloadseeds
reloadtriggers
removenode
repair
replaybatchlog
resetlocalschema
resumehandoff
ring
scrub
setcachecapacity
setcachekeystosave
setcompactionthreshold
setcompactionthroughput
sethintedhandoffthrottlekb
setinterdcstreamthroughput
setlogginglevel
setstreamthroughput
settimeout
settraceprobability
sjk
snapshot
status
statusbackup
statusbinary
statusgossip
statushandoff
statusthrift
stop
stopdaemon
tablehistograms
tablestats
toppartitions
tpstats
truncatehints
upgradesstables
verify
version
The cassandra utility
The cassandra-stress tool
Interpreting the output of cassandra-stress
SSTable utilities
sstabledump
sstableexpiredblockers
sstablelevelreset
sstableloader (Cassandra bulk loader)
sstablemetadata
sstableofflinerelevel
sstablepartitions
sstablerepairedset
sstablescrub
sstablesplit
sstableupgrade
sstableutil
sstableverify
Troubleshooting
Release notes
Home
Academy
Docs home
Contact us
Download DataStax
Glossary
Support
Developer blogs
Search
Home
Cassandra tools
The nodetool utility
The nodetool utility
A list of the available commands for managing a cluster.
About the nodetool utility
A command line interface for managing a cluster.
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
Manage a node's bootstrap process.
nodetool cfhistograms
This tool has been renamed.
nodetool cfstats
This tool has been renamed.
nodetool cleanup
Cleans up keyspaces and partition keys no longer belonging 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.
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 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 MB/s) for compaction 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 info
Provides node information, such as load and uptime.
nodetool invalidatecountercache
Resets the global counter cache parameter, counter_cache_keys_to_save, to the default (not set), which saves all keys.
nodetool invalidatekeycache
Resets the global key cache parameter to the default, which saves all keys.
nodetool invalidaterowcache
Resets the global key cache parameter, row_cache_keys_to_save, to the default (not set), which saves all keys.
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 by streaming from other nodes.
nodetool rebuild_index
Performs a full rebuild of the index for a table
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 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 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 setcachecapacity
Set global key and row cache capacities in megabytes.
nodetool setcachekeystosave
Sets the 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 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, or 0 to disable throttling.
nodetool setlogginglevel
Set the log level for a service.
nodetool setstreamthroughput
Sets the throughput capacity in Mb for outbound streaming in the system, or disables throttling.
nodetool settimeout
Set the specified timeout in milliseconds, or 0 to disable timeout.
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
Take a snapshot of one or more keyspaces, or of a table, to backup data.
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 statistics about a table that could be used to plot a frequency function.
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 Cassandra. Ensures that the SSTables are compatible with the current version.
nodetool verify
Verify (check data checksum for) one or more tables.
nodetool version
Provides the version number of Cassandra running on the specified node.
Cassandra tools
The nodetool utility
About the nodetool utility
abortrebuild
assassinate
bootstrap
cfhistograms
cfstats
cleanup
clearsnapshot
compact
compactionhistory
compactionstats
decommission
describecluster
describering
disableautocompaction
disablebackup
disablebinary
disablegossip
disablehandoff
disablehintsfordc
disablethrift
drain
enableautocompaction
enablebackup
enablebinary
enablegossip
enablehandoff
enablehintsfordc
enablethrift
failuredetector
flush
gcstats
getcompactionthreshold
getcompactionthroughput
getendpoints
getinterdcstreamthroughput
getlogginglevels
getseeds
getsstables
getstreamthroughput
gettimeout
gettraceprobability
gossipinfo
help
info
invalidatecountercache
invalidatekeycache
invalidaterowcache
join
listendpointspendinghints
listsnapshots
mark_unrepaired
move
netstats
pausehandoff
proxyhistograms
rangekeysample
rebuild
rebuild_index
refresh
refreshsizeestimates
reloadseeds
reloadtriggers
removenode
repair
replaybatchlog
resetlocalschema
resumehandoff
ring
scrub
setcachecapacity
setcachekeystosave
setcompactionthreshold
setcompactionthroughput
sethintedhandoffthrottlekb
setinterdcstreamthroughput
setlogginglevel
setstreamthroughput
settimeout
settraceprobability
sjk
snapshot
status
statusbackup
statusbinary
statusgossip
statushandoff
statusthrift
stop
stopdaemon
tablehistograms
tablestats
toppartitions
tpstats
truncatehints
upgradesstables
verify
version
The cassandra utility
The cassandra-stress tool
SSTable utilities