ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

You're viewing documentation for an unstable version of ScyllaDB Open Source. Switch to the latest stable version.

ScyllaDB Docs ScyllaDB Open Source ScyllaDB for Administrators Admin Tools Nodetool

Nodetool¶

The nodetool utility provides a simple command-line interface to the following exposed operations and attributes. Scylla’s nodetool is a fork of the Apache Cassandra nodetool with the same syntax and a subset of the operations.

Nodetool generic options¶

All options are supported:

( -h | --host ) <host name> | <ip address>
( -p | --port ) <port number>
( -pw | --password ) <password >
( -u | --username ) <user name>
( -pwf <passwordFilePath | --password-file <passwordFilePath> )

Supported Nodetool operations¶

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.

  • 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 - Reenable native transport (binary protocol).

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

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

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

  • statusbackup - Status of incremental backup.

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

  • statusgossip - Status of gossip.

  • status - Print cluster information.

  • stop compaction - 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 Scylla 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.

PREVIOUS
Admin Tools
NEXT
Nodetool cfhistograms (tablehistograms)
ScyllaDB Open Source
  • master
    • master
    • 5.2
    • 5.1
  • Getting Started
    • Install ScyllaDB
      • ScyllaDB Web Installer for Linux
      • ScyllaDB Unified Installer (relocatable executable)
      • Air-gapped Server Installation
      • What is in each RPM
      • ScyllaDB Housekeeping and how to disable it
      • ScyllaDB Developer Mode
      • ScyllaDB Configuration Reference
    • Configure ScyllaDB
    • ScyllaDB Requirements
      • System Requirements
      • OS Support by Linux Distributions and Version
      • ScyllaDB in a Shared Environment
    • Migrate to ScyllaDB
      • Migration Process from Cassandra to Scylla
      • Scylla and Apache Cassandra Compatibility
      • Migration Tools Overview
    • Integration Solutions
      • Integrate Scylla with Spark
      • Integrate Scylla with KairosDB
      • Integrate Scylla with Presto
      • Integrate Scylla with Elasticsearch
      • Integrate Scylla with Kubernetes
      • Integrate Scylla with the JanusGraph Graph Data System
      • Integrate Scylla with DataDog
      • Integrate Scylla with Kafka
      • Integrate Scylla with IOTA Chronicle
      • Integrate Scylla with Spring
      • Shard-Aware Kafka Connector for Scylla
      • Install Scylla with Ansible
      • Integrate Scylla with Databricks
    • Tutorials
  • ScyllaDB for Administrators
    • Administration Guide
    • Procedures
      • Cluster Management
      • Backup & Restore
      • Change Configuration
      • Maintenance
      • Best Practices
      • Benchmarking Scylla
      • Migrate from Cassandra to Scylla
      • Disable Housekeeping
    • Security
      • ScyllaDB Security Checklist
      • Enable Authentication
      • Enable and Disable Authentication Without Downtime
      • Generate a cqlshrc File
      • Reset Authenticator Password
      • Enable Authorization
      • Grant Authorization CQL Reference
      • Role Based Access Control (RBAC)
      • Encryption: Data in Transit Client to Node
      • Encryption: Data in Transit Node to Node
      • Generating a self-signed Certificate Chain Using openssl
      • Configure SaslauthdAuthenticator
    • Admin Tools
      • Nodetool Reference
      • CQLSh
      • REST
      • Tracing
      • Scylla SStable
      • Scylla Types
      • SSTableLoader
      • cassandra-stress
      • SSTabledump
      • SSTable2json
      • Scylla Logs
      • Seastar Perftune
      • Virtual Tables
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
    • ScyllaDB Manager
    • Upgrade Procedures
      • ScyllaDB Open Source
      • ScyllaDB Open Source to ScyllaDB Enterprise
      • ScyllaDB AMI
      • ScyllaDB Enterprise
    • System Configuration
      • System Configuration Guide
      • scylla.yaml
      • ScyllaDB Snitches
    • Benchmarking ScyllaDB
    • ScyllaDB Diagnostic Tools
  • ScyllaDB for Developers
    • Learn To Use ScyllaDB
      • Scylla University
      • Course catalog
      • Scylla Essentials
      • Basic Data Modeling
      • Advanced Data Modeling
      • MMS - Learn by Example
      • Care-Pet an IoT Use Case and Example
    • Scylla Alternator
    • Scylla Features
      • Scylla Open Source Features
      • Scylla Enterprise Features
    • Scylla Drivers
      • Scylla CQL Drivers
      • Scylla DynamoDB Drivers
    • Workload Attributes
  • CQL Reference
    • CQLSh: the CQL shell
    • Appendices
    • Compaction
    • Consistency Levels
    • Consistency Level Calculator
    • Data Definition
    • Data Manipulation
    • Data Types
    • Definitions
    • Global Secondary Indexes
    • Additional Information
    • Expiring Data with Time to Live (TTL)
    • Additional Information
    • Functions
    • Wasm support for user-defined functions
    • JSON Support
    • Materialized Views
    • Non-Reserved CQL Keywords
    • Reserved CQL Keywords
    • ScyllaDB CQL Extensions
  • ScyllaDB Architecture
    • ScyllaDB Ring Architecture
    • ScyllaDB Fault Tolerance
    • Consistency Level Console Demo
    • ScyllaDB Anti-Entropy
      • Scylla Hinted Handoff
      • Scylla Read Repair
      • Scylla Repair
    • SSTable
      • ScyllaDB SSTable - 2.x
      • ScyllaDB SSTable - 3.x
    • Compaction Strategies
    • Raft Consensus Algorithm in ScyllaDB
  • Troubleshooting ScyllaDB
    • Errors and Support
      • Report a Scylla problem
      • Error Messages
      • Change Log Level
    • ScyllaDB Startup
      • Ownership Problems
      • Scylla will not Start
      • Scylla Python Script broken
    • Upgrade
      • Inaccessible configuration files after ScyllaDB upgrade
    • Cluster and Node
      • Failed Decommission Problem
      • Cluster Timeouts
      • Node Joined With No Data
      • SocketTimeoutException
      • NullPointerException
    • Data Modeling
      • Scylla Large Partitions Table
      • Scylla Large Rows and Cells Table
      • Large Partitions Hunting
    • Data Storage and SSTables
      • Space Utilization Increasing
      • Disk Space is not Reclaimed
      • SSTable Corruption Problem
      • Pointless Compactions
      • Limiting Compaction
    • CQL
      • Time Range Query Fails
      • COPY FROM Fails
      • CQL Connection Table
      • Reverse queries fail
    • ScyllaDB Monitor and Manager
      • Manager and Monitoring integration
      • Manager lists healthy nodes as down
  • Knowledge Base
    • Upgrading from experimental CDC
    • Compaction
    • Consistency in ScyllaDB
    • Counting all rows in a table is slow
    • CQL Query Does Not Display Entire Result Set
    • When CQLSh query returns partial results with followed by “More”
    • Run Scylla and supporting services as a custom user:group
    • Decoding Stack Traces
    • Snapshots and Disk Utilization
    • DPDK mode
    • Debug your database with Flame Graphs
    • How to Change gc_grace_seconds for a Table
    • Gossip in Scylla
    • Increase Permission Cache to Avoid Non-paged Queries
    • How does Scylla LWT Differ from Apache Cassandra ?
    • Map CPUs to Scylla Shards
    • Scylla Memory Usage
    • NTP Configuration for Scylla
    • Updating the Mode in perftune.yaml After a ScyllaDB Upgrade
    • POSIX networking for Scylla
    • Scylla consistency quiz for administrators
    • Recreate RAID devices
    • How to Safely Increase the Replication Factor
    • Scylla and Spark integration
    • Increase Scylla resource limits over systemd
    • Scylla Seed Nodes
    • How to Set up a Swap Space
    • Scylla Snapshots
    • Scylla payload sent duplicated static columns
    • Stopping a local repair
    • System Limits
    • How to flush old tombstones from a table
    • Time to Live (TTL) and Compaction
    • Scylla Nodes are Unresponsive
    • Update a Primary Key
    • Using the perf utility with Scylla
    • Configure Scylla Networking with Multiple NIC/IP Combinations
  • Reference
    • ScyllaDB Enterprise vs. Open Source Matrix
  • ScyllaDB University
  • ScyllaDB FAQ
  • Contribute to ScyllaDB
  • Glossary
  • Alternator: DynamoDB API in Scylla
    • Getting Started With ScyllaDB Alternator
    • ScyllaDB Alternator for DynamoDB users
  • Create an issue
  • Edit this page

On this page

  • Nodetool
    • Nodetool generic options
    • Supported Nodetool operations
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 28 Mar 2023.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.3.5