Nodetool¶

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).

Supported Nodetool operations¶

Operations that are not listed below are currently not available.

• backup - Copy SSTables from a specified keyspace’s snapshot to a designated bucket in object storage.

• 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.

• cluster - Run a cluster operation.

• compact- Force a (major) compaction on one or more column families.

• compactionhistory - Provides the history of compactions.

• compactionstats- Print statistics on compactions.

• 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).

• dropquarantinedsstables <keyspace> <table> Drop quarantined SSTables from the specified keyspace and table(s), or from all keyspaces if no keyspace is specified.

• enableautocompaction - Enable automatic compaction of a keyspace or table.

• enablebackup - Enable incremental backup.

• enablebinary - Re-enable native transport (binary protocol).

• enablegossip - Re-enable gossip.

• excludenode- Mark nodes as permanently down.

• flush - Flush one or more column families.

• getcompactionthroughput - Print the throughput cap for compaction in the system

• 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.

• getstreamthroughput - Print the throughput cap for SSTables streaming in the system

• 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 vnode tables.

• resetlocalschema - Reset the node’s local schema.

• restore - Load SSTables from a designated bucket in object store into a specified keyspace or table

• 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)

• setcompactionthroughput - Set the throughput cap for compaction in the system

• setlogginglevel - sets the logging level threshold for ScyllaDB classes

• setstreamthroughput - Set the throughput cap for SSTables streaming in the system

• 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.

• status - Print cluster information.

• statusbackup - Status of incremental backup.

• statusbinary - Status of native transport (binary protocol).

• statusgossip - Status of gossip.

• stop - Stop compaction operation.

• tablehistograms see cfhistograms

• tablestats - Provides in-depth diagnostics regard table.

• tasks - Manage tasks manager tasks.

• 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.

• version - Print the DB version.

• viewbuildstatus - Shows the progress of a materialized view build.