Was this page helpful?
Caution
You're viewing documentation for a previous version of ScyllaDB Open Source. Switch to the latest stable version.
The nodetool
utility provides a simple command-line interface to the following exposed operations and attributes. ScyllaDB’s nodetool is a fork of the Apache Cassandra nodetool with the same syntax and a subset of the operations.
All options are supported:
-p <port>
or --port <port>
- Remote JMX agent port number.
-pp
or --print-port
- Operate in 4.0 mode with hosts disambiguated by port number.
-pw <password>
or --password <password>
- Remote JMX agent password.
-pwf <passwordFilePath>
or --password-file <passwordFilePath>
- Path to the JMX password file.
-u <username>
or --username <username>
- Remote JMX agent username.
--
- 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.
cfhistograms - Provides statistics about a table, including number of SSTables, read/write latency, partition size and column count.
cfstats - Provides in-depth diagnostics regard table.
checkandrepaircdcstreams - Checks and fixes CDC streams.
cleanup - Triggers the immediate cleanup of keys no longer belonging to a node.
clearsnapshot - This command removes snapshots.
compactionhistory - Provides the history of compactions.
compactionstats- Print statistics on compactions.
compact- Force a (major) compaction on one or more column families.
decommission - Decommission the node.
describecluster - Print the name, snitch, partitioner and schema version of a cluster.
describering - <keyspace>
- Shows the partition ranges of a given keyspace.
disableautocompaction - Disable automatic compaction of a keyspace or table.
disablebackup - Disable incremental backup.
disablebinary - Disable native transport (binary protocol).
disablegossip - Disable gossip (effectively marking the node down).
drain - Drain the node (stop accepting writes and flush all column families).
enableautocompaction - Enable automatic compaction of a keyspace or table.
enablebackup - Enable incremental backup.
enablebinary - Re-enable native transport (binary protocol).
enablegossip - Re-enable gossip.
flush - Flush one or more column families.
getendpoints <keyspace>
<table>
<key>
- Print the end points that owns the key.
getlogginglevels - Get the runtime logging levels.
getsstables - Print the sstable filenames that own the key.
gettraceprobability - Displays the current trace probability value. 0 is disabled 1 is enabled.
gossipinfo - Shows the gossip information for the cluster.
help - Display list of available nodetool commands.
info - Print node information
listsnapshots - Lists all the snapshots along with the size on disk and true size.
move <new token>
- Move node on the token ring to a new token
netstats - Print network information on provided host (connecting node by default)
proxyhistograms - Print statistic histograms for network operations
rebuild [<src-dc-name>]
- Rebuild data by streaming from other nodes
refresh- Load newly placed SSTables to the system without restart
removenode- Remove node with the provided ID
repair <keyspace>
<table>
- Repair one or more tables
resetlocalschema - Reset the node’s local schema.
ring - The nodetool ring command display the token ring information.
scrub [-m mode] [--no-snapshot] <keyspace> [<table>...]
- Scrub the SSTable files in the specified keyspace or table(s)
setlogginglevel - sets the logging level threshold for ScyllaDB classes
settraceprobability <value>
- Sets the probability for tracing a request. race probability value
snapshot [-t tag] [-cf column_family] <keyspace>
- Take a snapshot of specified keyspaces or a snapshot of the specified table.
sstableinfo - Get information about sstables per keyspace/table.
statusbackup - Status of incremental backup.
statusbinary - Status of native transport (binary protocol).
statusgossip - Status of gossip.
status - Print cluster information.
stop - Stop compaction operation.
tablehistograms see cfhistograms
tablestats - Provides in-depth diagnostics regard table.
toppartitions - Samples cluster writes and reads and reports the most active partitions in a specified table and time frame.
upgradesstables - Upgrades each table that is not running the latest ScyllaDB version, by rewriting SSTables.
viewbuildstatus - Shows the progress of a materialized view build.
version - Print the DB version.
Copyright
© 2016, The Apache Software Foundation.
Apache®, Apache Cassandra®, Cassandra®, the Apache feather logo and the Apache Cassandra® Eye logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. No endorsement by The Apache Software Foundation is implied by the use of these marks.
Was this page helpful?