| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1.0"> |
| <title>Untitled | Apache Cassandra Documentation</title> |
| <link rel="stylesheet" href="../../../../../assets/css/site.css"> |
| <link rel="schema.dcterms" href="https://purl.org/dc/terms/"> |
| <meta name="dcterms.subject" content="Cassandra"> |
| <meta name="dcterms.identifier" content="4.1"> |
| <meta name="generator" content="Antora 2.3.4"> |
| <link rel="icon" href="../../../../../assets/img/favicon.ico" type="image/x-icon"> |
| <script> |
| const script = document.createElement("script"); |
| const domain = window.location.hostname; |
| script.type = "text/javascript"; |
| script.src = "https://plausible.cassandra.apache.org/js/plausible.js"; |
| script.setAttribute("data-domain",domain); |
| script.setAttribute("defer",'true'); |
| script.setAttribute("async",'true'); |
| document.getElementsByTagName("head")[0].appendChild(script); |
| </script> </head> |
| <body class="docs-wrapper article"> |
| <div class="container mx-auto relative"> |
| <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script> |
| <meta property="og:type" content="website" /> |
| <meta property="og:url" content="/" /> |
| <meta property="og:site_name" content="Apache Cassandra" /> |
| |
| <header id="top-nav"> |
| <div class="inner relative"> |
| <div class="header-social-icons text-right"> |
| <a href="https://twitter.com/cassandra?lang=en" target="_blank" styles="margin-left: 20px;"><img src="../../../../../assets/img/twitter-icon-circle-white.svg" alt="twitter icon" width="24"></a> |
| <a href="https://www.linkedin.com/company/apache-cassandra/" target="_blank" styles="margin-left: 20px;"><img src="../../../../../assets/img/LI-In-Bug.png" alt="linked-in icon" width="24"></a> |
| <a href="https://www.youtube.com/c/PlanetCassandra" target="_blank" styles="margin-left: 20px;"><img src="../../../../../assets/img/youtube-icon.png" alt="youtube icon" width="24"></a> |
| </div> |
| <div class="cf"> |
| <div class="logo left"><a href="/"><img src="../../../../../assets/img/logo-white-r.png" alt="Cassandra Logo"></a></div> |
| <div class="mobile-nav-icon right"> |
| <img class="toggle-icon" src="../../../../../assets/img/hamburger-nav.svg"> |
| </div> |
| <ul class="main-nav nav-links right flex flex-vert-center flex-space-between"> |
| <li> |
| <a class="nav-link hide-mobile">Get Started</a> |
| <ul class="sub-menu bg-white"> |
| <li class="pa-micro"> |
| <a href="/_/cassandra-basics.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-basics.png" alt="cassandra basics icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Cassandra Basics |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro"> |
| <a href="/_/quickstart.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-rocket.png" alt="cassandra basics icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Quickstart |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro"> |
| <a href="/_/ecosystem.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-ecosystem.png" alt="cassandra basics icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Ecosystem |
| </div> |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li><a class="nav-link" href="/doc/latest/">Documentation</a></li> |
| <li> |
| <a class="nav-link" href="/_/community.html">Community</a> |
| <ul class="sub-menu bg-white"> |
| <li class="pa-micro"> |
| <a href="/_/community.html#code-of-conduct"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-welcome.png" alt="welcome icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Welcome |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/community.html#discussions"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-discussions.png" alt="discussions icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Discussions |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/community.html#project-governance"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-governance.png" alt="Governance icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Governance |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/community.html#how-to-contribute"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-contribute.png" alt="Contribute icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Contribute |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/community.html#meet-the-community"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-community.png" alt="Meet the Community icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Meet the Community |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/cassandra-catalyst-program.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-catalyst.png" alt="Catalyst icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Catalyst Program |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/events.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-events.png" alt="Events icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Events |
| </div> |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <a class="nav-link hide-mobile">Learn</a> |
| <ul class="sub-menu bg-white"> |
| <li class="pa-micro"> |
| <a href="/_/Apache-Cassandra-5.0-Moving-Toward-an-AI-Driven-Future.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-basics.png" alt="Basics icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Cassandra 5.0 |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro"> |
| <a href="/_/case-studies.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-case-study.png" alt="Case Studies icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Case Studies |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro"> |
| <a href="/_/resources.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-resources.png" alt="Resources icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Resources |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro"> |
| <a href="/_/blog.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../../assets/img/sub-menu-blog.png" alt="Blog icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Blog |
| </div> |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li><a class="nav-link btn btn--filled" href="/_/download.html">Download Now</a></li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| |
| <div class="hero hero--home grad"> |
| <div class="eye"></div> |
| <div id="docs-content" class="text-center flex flex-center flex-column relative z2 ma-xlarge"> |
| <h2>Cassandra Documentation</h2> |
| </div> |
| </div> |
| <div class="body px-medium py-medium container"> |
| <div class="docs-nav-bar flex flex-space-between mb-medium"> |
| <div id="mobile-docs-nav-burger" class="hidden"> |
| <svg viewBox="0 0 24 24" width="36" height="36" stroke="#1c81a0" stroke-width="2.5" fill="none" stroke-linecap="round" stroke-linejoin="round" class="css-i6dzq1"><line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line></svg> |
| </div> |
| <div class="docs-nav-item relative"> |
| <input id="search-input" type="text" placeholder="Search docs"> |
| </div> |
| <div class="versions-wrapper"> |
| <h4>Version:</h4> |
| <div class="nav-panel-explore" data-panel="explore"> |
| |
| <div id="version-toggle" class="context"> |
| <span class="version">4.1</span> |
| </div> |
| <ul id="versions-list" class="components"> |
| <li class="component"> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../_/index.html">master</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component is-current"> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../../trunk/index.html">trunk</a> |
| </li> |
| <li class="version"> |
| <a href="../../../../5.0/index.html">5.0</a> |
| </li> |
| <li class="version is-current is-latest"> |
| <a href="../../../index.html">4.1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../../4.0/index.html">4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../../3.11/index.html">3.11</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> </div> |
| <div class="cf relative"> |
| <nav class="nav docs-nav full-800"> |
| <div class="nav-menu"> |
| <ul class="nav-list"> |
| <li class="nav-item is-active" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../../index.html">Main</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/glossary.html">Glossary</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/bugs.html">How to report bugs</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/contactus.html">Contact us</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item is-active" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item is-current-path is-active" data-depth="1"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <span class="nav-text">Cassandra</span> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../getting_started/index.html">Getting Started</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../getting_started/installing.html">Installing Cassandra</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../getting_started/configuring.html">Configuring Cassandra</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../getting_started/querying.html">Inserting and querying</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../getting_started/drivers.html">Client drivers</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../getting_started/java11.html">Support for Java 11</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../getting_started/production.html">Production recommendations</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../new/index.html">What’s new</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../architecture/index.html">Architecture</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../architecture/overview.html">Overview</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../architecture/dynamo.html">Dynamo</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../architecture/storage_engine.html">Storage engine</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../architecture/guarantees.html">Guarantees</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../architecture/messaging.html">Improved internode messaging</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../architecture/streaming.html">Improved streaming</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../data_modeling/index.html">Data modeling</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../data_modeling/intro.html">Introduction</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../data_modeling/data_modeling_conceptual.html">Conceptual data modeling</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../data_modeling/data_modeling_rdbms.html">RDBMS design</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../data_modeling/data_modeling_queries.html">Defining application queries</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../data_modeling/data_modeling_logical.html">Logical data modeling</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../data_modeling/data_modeling_physical.html">Physical data modeling</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../data_modeling/data_modeling_refining.html">Evaluating and refining data models</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../data_modeling/data_modeling_schema.html">Defining database schema</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../data_modeling/data_modeling_tools.html">Cassandra data modeling tools</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../cql/index.html">Cassandra Query Language (CQL)</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/definitions.html">Definitions</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/types.html">Data types</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/ddl.html">Data definition (DDL)</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/dml.html">Data manipulation (DML)</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/operators.html">Operators</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/indexes.html">Secondary indexes</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/mvs.html">Materialized views</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/functions.html">Functions</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/json.html">JSON</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/security.html">Security</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/triggers.html">Triggers</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/appendices.html">Appendices</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/changes.html">Changes</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/SASI.html">SASI</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../cql/cql_singlefile.html">Single file of CQL information</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../configuration/index.html">Configuration</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../configuration/cass_yaml_file.html">cassandra.yaml</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../configuration/cass_rackdc_file.html">cassandra-rackdc.properties</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../configuration/cass_env_sh_file.html">cassandra-env.sh</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../configuration/cass_topo_file.html">cassandra-topologies.properties</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../configuration/cass_cl_archive_file.html">commitlog-archiving.properties</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../configuration/cass_logback_xml_file.html">logback.xml</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../configuration/cass_jvm_options_file.html">jvm-* files</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../configuration/configuration.html">Liberating cassandra.yaml Parameters' Names from Their Units</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../operating/index.html">Operating</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="#operating/snitch.adoc">Snitches</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/topo_changes.html">Topology changes</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/repair.html">Repair</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/read_repair.html">Read repair</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/hints.html">Hints</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/bloom_filters.html">Bloom filters</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/compression.html">Compression</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/cdc.html">Change Data Capture (CDC)</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/backups.html">Backups</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/bulk_loading.html">Bulk loading</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/metrics.html">Metrics</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/security.html">Security</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/hardware.html">Hardware</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/compaction/index.html">Compaction</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/virtualtables.html">Virtual tables</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/auditlogging.html">Audit logging</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/audit_logging.html">Audit logging 2</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/fqllogging.html">Full query logging</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../operating/transientreplication.html">Transient replication</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item is-current-path is-active" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../index.html">Tools</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../cqlsh.html">cqlsh: the CQL shell</a> |
| </span> |
| </li> |
| <li class="nav-item is-current-page is-active" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="nodetool.html">nodetool</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../sstable/index.html">SSTable tools</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../cassandra_stress.html">cassandra-stress</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../troubleshooting/index.html">Troubleshooting</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../troubleshooting/finding_nodes.html">Finding misbehaving nodes</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../troubleshooting/reading_logs.html">Reading Cassandra logs</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../troubleshooting/use_nodetool.html">Using nodetool</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../troubleshooting/use_tools.html">Using external tools to deep-dive</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../../../../_/development/index.html">Development</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/gettingstarted.html">Getting started</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/ide.html">Building and IDE integration</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/testing.html">Testing</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/patches.html">Contributing code changes</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/code_style.html">Code style</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/how_to_review.html">Review checklist</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/how_to_commit.html">How to commit</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/documentation.html">Working on documentation</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/ci.html">Jenkins CI environment</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/dependencies.html">Dependency management</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../../_/development/release_process.html">Release process</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../faq/index.html">FAQ</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../plugins/index.html">Plug-ins</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </nav> |
| <aside class="toc sidebar"> |
| <div class="toc-menu"></div> |
| </aside> |
| <main class="article default-main full-800" data-ceiling="topbar"> |
| <div class="article-header"> |
| <nav class="crumbs" aria-label="breadcrumbs"> |
| <ul> |
| <li class="crumb">Cassandra</li> |
| <li class="crumb"><a href="../index.html">Tools</a></li> |
| <li class="crumb"><a href="nodetool.html">nodetool</a></li> |
| </ul> |
| </nav> |
| <div class="tools" role="navigation"> |
| <ul> |
| <li class="tool edit"><a href="https://github.com/apache/cassandra/edit/cassandra-4.1/doc/modules/cassandra/pages/tools/nodetool/nodetool.adoc" title="Edit Page" target="_blank" rel="noopener">Edit</a></li> |
| </ul> |
| </div> |
| </div> |
| <article class="doc"> |
| <div class="sect1"> |
| <h2 id="nodetool"><a class="anchor" href="#nodetool"></a>Nodetool</h2> |
| <div class="sectionbody"> |
| |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="usage"><a class="anchor" href="#usage"></a>Usage</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>usage: nodetool [(-pw <password> | --password <password>)] |
| [(-h <host> | --host <host>)] |
| [(-pwf <passwordFilePath> | --password-file <passwordFilePath>)] |
| [(-pp | --print-port)] [(-p <port> | --port <port>)] |
| [(-u <username> | --username <username>)] <command> [<args>]</p> |
| </div> |
| <div class="paragraph"> |
| <p>The most commonly used nodetool commands are:</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="assassinate.html" class="page">assassinate</a> - Forcefully remove a dead node without re-replicating any data. Use as a last resort if you cannot removenode</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="bootstrap.html" class="page">bootstrap</a> - Monitor/manage node’s bootstrap process</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="cleanup.html" class="page">cleanup</a> - Triggers the immediate cleanup of keys no longer belonging to a node. By default, clean all keyspaces</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="clearsnapshot.html" class="page">clearsnapshot</a> - Remove the snapshot with the given name from the given keyspaces</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="clientstats.html" class="page">clientstats</a> - Print information about connected clients</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="compact.html" class="page">compact</a> - Force a (major) compaction on one or more tables or user-defined compaction on given SSTables</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="compactionhistory.html" class="page">compactionhistory</a> - Print history of compaction</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="compactionstats.html" class="page">compactionstats</a> - Print statistics on compactions</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="datapaths.html" class="page">datapaths</a> - Print all directories where data of tables are stored</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="decommission.html" class="page">decommission</a> - Decommission the <strong>node I am connecting to</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="describecluster.html" class="page">describecluster</a> - Print the name, snitch, partitioner and schema version of a cluster</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="describering.html" class="page">describering</a> - Shows the token ranges info of a given keyspace</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="disableauditlog.html" class="page">disableauditlog</a> - Disable the audit log</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="disableautocompaction.html" class="page">disableautocompaction</a> - Disable autocompaction for the given keyspace and table</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="disablebackup.html" class="page">disablebackup</a> - Disable incremental backup</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="disablebinary.html" class="page">disablebinary</a> - Disable native transport (binary protocol)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="disablefullquerylog.html" class="page">disablefullquerylog</a> - Disable the full query log</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="disablegossip.html" class="page">disablegossip</a> - Disable gossip (effectively marking the node down)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="disablehandoff.html" class="page">disablehandoff</a> - Disable storing hinted handoffs</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="disablehintsfordc.html" class="page">disablehintsfordc</a> - Disable hints for a data center</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="disableoldprotocolversions.html" class="page">disableoldprotocolversions</a> - Disable old protocol versions</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="drain.html" class="page">drain</a> - Drain the node (stop accepting writes and flush all tables)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="enableauditlog.html" class="page">enableauditlog</a> - Enable the audit log</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="enableautocompaction.html" class="page">enableautocompaction</a> - Enable autocompaction for the given keyspace and table</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="enablebackup.html" class="page">enablebackup</a> - Enable incremental backup</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="enablebinary.html" class="page">enablebinary</a> - Reenable native transport (binary protocol)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="enablefullquerylog.html" class="page">enablefullquerylog</a> - Enable full query logging, defaults for the options are configured in cassandra.yaml</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="enablegossip.html" class="page">enablegossip</a> - Reenable gossip</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="enablehandoff.html" class="page">enablehandoff</a> - Reenable future hints storing on the current node</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="enablehintsfordc.html" class="page">enablehintsfordc</a> - Enable hints for a data center that was previsouly disabled</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="enableoldprotocolversions.html" class="page">enableoldprotocolversions</a> - Enable old protocol versions</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="failuredetector.html" class="page">failuredetector</a> - Shows the failure detector information for the cluster</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="flush.html" class="page">flush</a> - Flush one or more tables</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="garbagecollect.html" class="page">garbagecollect</a> - Remove deleted data from one or more tables</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="gcstats.html" class="page">gcstats</a> - Print GC Statistics</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getauditlog.html" class="page">getauditlog</a> - Print configuration of audit log if enabled, otherwise the configuration reflected in cassandra.yaml</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getauthcacheconfig.html" class="page">getauthcacheconfig</a> - Get configuration of Auth cache</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getbatchlogreplaythrottle.html" class="page">getbatchlogreplaythrottle</a> - Print batchlog replay throttle in KB/s. This is reduced proportionally to the number of nodes in the cluster.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getcolumnindexsize.html" class="page">getcolumnindexsize</a> - Print the granularity of the collation index of rows within a partition in KiB</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getcompactionthreshold.html" class="page">getcompactionthreshold</a> - Print min and max compaction thresholds for a given table</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getcompactionthroughput.html" class="page">getcompactionthroughput</a> - Print the MiB/s throughput cap for compaction in the system as a rounded number</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getconcurrency.html" class="page">getconcurrency</a> - Get maximum concurrency for processing stages</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getconcurrentcompactors.html" class="page">getconcurrentcompactors</a> - Get the number of concurrent compactors in the system.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getconcurrentviewbuilders.html" class="page">getconcurrentviewbuilders</a> - Get the number of concurrent view builders in the system</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getdefaultrf.html" class="page">getdefaultrf</a> - Gets default keyspace replication factor.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getendpoints.html" class="page">getendpoints</a> - Print the end points that owns the key</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getfullquerylog.html" class="page">getfullquerylog</a> - Print configuration of fql if enabled, otherwise the configuration reflected in cassandra.yaml</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getinterdcstreamthroughput.html" class="page">getinterdcstreamthroughput</a> - Print the throughput cap for inter-datacenter streaming and entire SSTable inter-datacenter streaming in the systemin rounded megabits. For precise number, please, use option -d</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getlogginglevels.html" class="page">getlogginglevels</a> - Get the runtime logging levels</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getmaxhintwindow.html" class="page">getmaxhintwindow</a> - Print the max hint window in ms</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getseeds.html" class="page">getseeds</a> - Get the currently in use seed node IP list excluding the node IP</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getsnapshotthrottle.html" class="page">getsnapshotthrottle</a> - Print the snapshot_links_per_second throttle for snapshot/clearsnapshot</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getsstables.html" class="page">getsstables</a> - Print the sstable filenames that own the key</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="getstreamthroughput.html" class="page">getstreamthroughput</a> - Print the throughput cap for streaming and entire SSTable streaming in the system in rounded megabits. For precise number, please, use option -d</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="gettimeout.html" class="page">gettimeout</a> - Print the timeout of the given type in ms</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="gettraceprobability.html" class="page">gettraceprobability</a> - Print the current trace probability value</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="gossipinfo.html" class="page">gossipinfo</a> - Shows the gossip information for the cluster</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="help.html" class="page">help</a> - Display help information</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="import.html" class="page">import</a> - Import new SSTables to the system</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="info.html" class="page">info</a> - Print node information (uptime, load, …​)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="invalidatecountercache.html" class="page">invalidatecountercache</a> - Invalidate the counter cache</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="invalidatecredentialscache.html" class="page">invalidatecredentialscache</a> - Invalidate the credentials cache</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="invalidatejmxpermissionscache.html" class="page">invalidatejmxpermissionscache</a> - Invalidate the JMX permissions cache</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="invalidatekeycache.html" class="page">invalidatekeycache</a> - Invalidate the key cache</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="invalidatenetworkpermissionscache.html" class="page">invalidatenetworkpermissionscache</a> - Invalidate the network permissions cache</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="invalidatepermissionscache.html" class="page">invalidatepermissionscache</a> - Invalidate the permissions cache</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="invalidaterolescache.html" class="page">invalidaterolescache</a> - Invalidate the roles cache</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="invalidaterowcache.html" class="page">invalidaterowcache</a> - Invalidate the row cache</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="join.html" class="page">join</a> - Join the ring</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="listpendinghints.html" class="page">listpendinghints</a> - Print all pending hints that this node has</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="listsnapshots.html" class="page">listsnapshots</a> - Lists all the snapshots along with the size on disk and true size. True size is the total size of all SSTables which are not backed up to disk. Size on disk is total size of the snapshot on disk. Total TrueDiskSpaceUsed does not make any SSTable deduplication.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="move.html" class="page">move</a> - Move node on the token ring to a new token</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="netstats.html" class="page">netstats</a> - Print network information on provided host (connecting node by default)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="pausehandoff.html" class="page">pausehandoff</a> - Pause hints delivery process</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="profileload.html" class="page">profileload</a> - Low footprint profiling of activity for a period of time</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="proxyhistograms.html" class="page">proxyhistograms</a> - Print statistic histograms for network operations</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="rangekeysample.html" class="page">rangekeysample</a> - Shows the sampled keys held across all keyspaces</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="rebuild.html" class="page">rebuild</a> - Rebuild data by streaming from other nodes (similarly to bootstrap)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="rebuild_index.html" class="page">rebuild_index</a> - A full rebuild of native secondary indexes for a given table</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="recompress_sstables.html" class="page">recompress_sstables</a> - Rewrite sstables (for the requested tables) that have compression configuration different from the current</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="refresh.html" class="page">refresh</a> - Load newly placed SSTables to the system without restart</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="refreshsizeestimates.html" class="page">refreshsizeestimates</a> - Refresh system.size_estimates</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="reloadlocalschema.html" class="page">reloadlocalschema</a> - Reload local node schema from system tables</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="reloadseeds.html" class="page">reloadseeds</a> - Reload the seed node list from the seed node provider</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="reloadssl.html" class="page">reloadssl</a> - Signals Cassandra to reload SSL certificates</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="reloadtriggers.html" class="page">reloadtriggers</a> - Reload trigger classes</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="relocatesstables.html" class="page">relocatesstables</a> - Relocates sstables to the correct disk</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="removenode.html" class="page">removenode</a> - Show status of current node removal, force completion of pending removal or remove provided ID</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="repair.html" class="page">repair</a> - Repair one or more tables</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="repair_admin.html" class="page">repair_admin</a> - |
| <a href="#tools/nodetool/list.adoc" class="page unresolved">list</a> - and fail incremental repair sessions</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="replaybatchlog.html" class="page">replaybatchlog</a> - Kick off batchlog replay and wait for finish</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="resetfullquerylog.html" class="page">resetfullquerylog</a> - Stop the full query log and clean files in the configured full query log directory from cassandra.yaml as well as JMX</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="resetlocalschema.html" class="page">resetlocalschema</a> - Reset node’s local schema and resync</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="resumehandoff.html" class="page">resumehandoff</a> - Resume hints delivery process</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="ring.html" class="page">ring</a> - Print information about the token ring</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="scrub.html" class="page">scrub</a> - Scrub (rebuild sstables for) one or more tables</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setauthcacheconfig.html" class="page">setauthcacheconfig</a> - Set configuration for Auth cache</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setbatchlogreplaythrottle.html" class="page">setbatchlogreplaythrottle</a> - Set batchlog replay throttle in KB per second, or 0 to disable throttling. This will be reduced proportionally to the number of nodes in the cluster.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setcachecapacity.html" class="page">setcachecapacity</a> - Set global key, row, and counter cache capacities (in MB units)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setcachekeystosave.html" class="page">setcachekeystosave</a> - Set number of keys saved by each cache for faster post-restart warmup. 0 to disable</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setcolumnindexsize.html" class="page">setcolumnindexsize</a> - Set the granularity of the collation index of rows within a partition in KiB</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setcompactionthreshold.html" class="page">setcompactionthreshold</a> - Set min and max compaction thresholds for a given table</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setcompactionthroughput.html" class="page">setcompactionthroughput</a> - Set the MiB/s throughput cap for compaction in the system, or 0 to disable throttling</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setconcurrency.html" class="page">setconcurrency</a> - Set maximum concurrency for processing stage</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setconcurrentcompactors.html" class="page">setconcurrentcompactors</a> - Set number of concurrent compactors in the system.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setconcurrentviewbuilders.html" class="page">setconcurrentviewbuilders</a> - Set the number of concurrent view builders in the system</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setdefaultrf.html" class="page">setdefaultrf</a> - Sets default keyspace replication factor.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="sethintedhandoffthrottlekb.html" class="page">sethintedhandoffthrottlekb</a> - Set hinted handoff throttle in KiB per second, per delivery thread.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setinterdcstreamthroughput.html" class="page">setinterdcstreamthroughput</a> - Set the throughput cap for inter-datacenter streaming and entire SSTable inter-datacenter streaming in the system, or 0 to disable throttling</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setlogginglevel.html" class="page">setlogginglevel</a> - Set the log level threshold for a given component or class. Will reset to the initial configuration if called with no parameters.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setmaxhintwindow.html" class="page">setmaxhintwindow</a> - Set the specified max hint window in ms</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setsnapshotthrottle.html" class="page">setsnapshotthrottle</a> - Set the snapshot_links_per_second cap for snapshot and clearsnapshot throttling</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="setstreamthroughput.html" class="page">setstreamthroughput</a> - Set throughput cap for streaming and entire SSTable streaming in the system, or 0 to disable throttling</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="settimeout.html" class="page">settimeout</a> - Set the specified timeout in ms, or 0 to disable timeout</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="settraceprobability.html" class="page">settraceprobability</a> - Sets the probability for tracing any given request to value. 0 disables, 1 enables for all requests, 0 is the default</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="sjk.html" class="page">sjk</a> - Run commands of 'Swiss Java Knife'. Run 'nodetool sjk --help' for more information.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="snapshot.html" class="page">snapshot</a> - Take a snapshot of specified keyspaces or a snapshot of the specified table</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="status.html" class="page">status</a> - Print cluster information (state, load, IDs, …​)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="statusautocompaction.html" class="page">statusautocompaction</a> - |
| <a href="status.html" class="page">status</a> - of autocompaction of the given keyspace and table</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="statusbackup.html" class="page">statusbackup</a> - Status of incremental backup</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="statusbinary.html" class="page">statusbinary</a> - Status of native transport (binary protocol)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="statusgossip.html" class="page">statusgossip</a> - Status of gossip</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="statushandoff.html" class="page">statushandoff</a> - Status of storing future hints on the current node</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="stop.html" class="page">stop</a> - Stop compaction</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="stopdaemon.html" class="page">stopdaemon</a> - Stop cassandra daemon</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="tablehistograms.html" class="page">tablehistograms</a> - Print statistic histograms for a given table</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="tablestats.html" class="page">tablestats</a> - Print statistics on tables</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="toppartitions.html" class="page">toppartitions</a> - Sample and print the most active partitions</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="tpstats.html" class="page">tpstats</a> - Print usage statistics of thread pools</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="truncatehints.html" class="page">truncatehints</a> - Truncate all hints on the local node, or truncate hints for the endpoint(s) specified.</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="upgradesstables.html" class="page">upgradesstables</a> - Rewrite sstables (for the requested tables) that are not on the current version (thus upgrading them to said current version)</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="verify.html" class="page">verify</a> - Verify (check data checksum for) one or more tables</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="version.html" class="page">version</a> - Print cassandra version</p> |
| </div> |
| <div class="paragraph"> |
| <p><a href="viewbuildstatus.html" class="page">viewbuildstatus</a> - Show progress of a materialized view build</p> |
| </div> |
| <div class="paragraph"> |
| <p>See 'nodetool help <command>' for more information on a specific command.</p> |
| </div> |
| </div> |
| </div> |
| </article> |
| </main> |
| </div> |
| </div> |
| <footer class="grad grad--two flex-center pb-xlarge"> |
| <div class="inner text-center z2 relative"> |
| <h2 class="white py-small">Get started with Cassandra, fast.</h2> |
| <a id="footer-cta" href="/_/quickstart.html" class="btn btn--filled ma-medium">Quickstart Guide</a> |
| </div> |
| <div class="inner flex flex-distribute-items mt-xlarge z2 relative"> |
| <div class="col-2"> |
| <div id="footer-logo" class="logo logo--footer mb-medium"><img src="../../../../../assets/img/logo-white-r.png" alt="Cassandra Logo"></div> |
| <p>Apache Cassandra<img src="../../../../../assets/img/registered.svg" alt="®" style="width:18px;"> powers mission-critical deployments with improved performance and unparalleled levels of scale in the cloud.</p> |
| <div class="footer-social-icons"> |
| <a href="https://twitter.com/cassandra?lang=en" target="_blank"><img src="../../../../../assets/img/twitter-icon-circle-white.svg" alt="twitter icon" width="24"></a> |
| <a href="https://www.linkedin.com/company/apache-cassandra/" target="_blank"><img src="../../../../../assets/img/LI-In-Bug.png" alt="linked-in icon" width="24"></a> |
| <a href="https://www.youtube.com/c/PlanetCassandra" target="_blank"><img src="../../../../../assets/img/youtube-icon.png" alt="youtube icon" width="24"></a> |
| </div> |
| </div> |
| <div class="col-2 flex flex-center"> |
| <ul class="columns-2"> |
| <li class="mb-small"><a href="/">Home</a></li> |
| <li class="mb-small"><a href="/_/cassandra-basics.html">Cassandra Basics</a></li> |
| <li class="mb-small"><a href="/_/quickstart.html">Quickstart</a></li> |
| <li class="mb-small"><a href="/_/ecosystem.html">Ecosystem</a></li> |
| <li class="mb-small"><a href="/doc/latest/">Documentation</a></li> |
| <li class="mb-small"><a href="/_/community.html">Community</a></li> |
| <li class="mb-small"><a href="/_/case-studies.html">Case Studies</a></li> |
| <li class="mb-small"><a href="/_/resources.html">Resources</a></li> |
| <li class="mb-small"><a href="/_/blog.html">Blog</a></li> |
| </ul> |
| </div> |
| </div> |
| </footer> |
| <div class="lower-footer bg-white pa-medium"> |
| <div class="flex flex-row flex-vert-center"> |
| <div class="pr-medium"><img src="../../../../../assets/img//feather-small.png" alt="ASF" width="20"></div> |
| <div class="pr-medium"><a href="http://www.apache.org/" target="_blank">Foundation</a></div> |
| <div class="pr-medium"><a href="https://www.apache.org/events/current-event.html" target="_blank">Events</a></div> |
| <div class="pr-medium"><a href="https://www.apache.org/licenses/" target="_blank">License</a></div> |
| <div class="pr-medium"><a href="https://www.apache.org/foundation/thanks" target="_blank">Thanks</a></div> |
| <div class="pr-medium"><a href="https://www.apache.org/security" target="_blank">Security</a></div> |
| <div class="pr-medium"><a href="https://privacy.apache.org/policies/privacy-policy-public.html" target="_blank">Privacy</a></div> |
| <div class="pr-medium"><a href="https://www.apache.org/foundation/sponsorship" target="_blank">Sponsorship</a></div> |
| </div> |
| <p class="my-medium">© 2009-<script>document.write(new Date().getFullYear())</script> <a href="https://apache.org" target="_blank">The Apache Software Foundation</a> under the terms of the Apache License 2.0. Apache, the Apache feather logo, Apache Cassandra, Cassandra, and the Cassandra logo, are either registered trademarks or trademarks of The Apache Software Foundation.</p> |
| </div> |
| <div id="fade" class="hidden"></div> |
| <div id="modal" class="hidden"> |
| <div id="close-modal" class="cursor-pointer"><svg viewBox="0 0 24 24" width="24" height="24" stroke="currentColor" stroke-width="2" fill="none" stroke-linecap="round" stroke-linejoin="round" class="css-i6dzq1"><line x1="18" y1="6" x2="6" y2="18"></line><line x1="6" y1="6" x2="18" y2="18"></line></svg></div> |
| <div id="mod-content" class="vid-mod-content resp-container"></div> |
| </div> |
| <script src="../../../../../assets/js/site.js"></script> |
| <script async src="../../../../../assets/js/vendor/highlight.js"></script> |
| <script src="../../../../../assets/js/vendor/lunr.js"></script> |
| <script src="../../../../../assets/js/vendor/search.js" id="search-script" data-base-path="../../../../.." data-page-path="/Cassandra/4.1/cassandra/tools/nodetool/nodetool.html"></script> |
| <script async src="../../../../../assets/../search-index.js"></script> |
| <script> |
| jQuery(function(){ |
| var windowW = $(window).width(); |
| $(document) |
| .on('click','.mobile-nav-icon',function(){ |
| $('.main-nav').fadeIn(); |
| }) |
| .on('click','.main-nav',function(){ |
| if(windowW <= 1000){ |
| $(this).fadeOut(); |
| } |
| }) |
| .on('click','#version-toggle',function(){ |
| $(this).toggleClass('active'); |
| $(this).next().fadeToggle(); |
| }) |
| .on('click','#mobile-docs-nav-burger', function(){ |
| $(this).toggleClass('active'); |
| $('.docs-nav').toggleClass('active'); |
| }); |
| var url = window.location.pathname; |
| var isQuickstart = url.includes('quickstart.html'); |
| if(isQuickstart){ |
| var footerCTA = document.getElementById('footer-cta'); |
| footerCTA.innerHTML = 'Get latest updates'; |
| footerCTA.setAttribute('href', '/_/blog.html'); |
| } |
| }); |
| </script> |
| </div> |
| </body> |
| </html> |
