| --- |
| layout: docpage |
| |
| title: "Documentation" |
| |
| is_homepage: false |
| is_sphinx_doc: true |
| |
| doc-title: "Cassandra Tools" |
| doc-header-links: ' |
| <link rel="top" title="Apache Cassandra Documentation v4.0-alpha3" href="../index.html"/> |
| <link rel="next" title="cqlsh: the CQL shell" href="cqlsh.html"/> |
| <link rel="prev" title="Hardware Choices" href="../operating/hardware.html"/> |
| ' |
| doc-search-path: "../search.html" |
| |
| extra-footer: ' |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: "", |
| VERSION: "", |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: ".html", |
| HAS_SOURCE: false, |
| SOURCELINK_SUFFIX: ".txt" |
| }; |
| </script> |
| ' |
| |
| --- |
| <div class="container-fluid"> |
| <div class="row"> |
| <div class="col-md-3"> |
| <div class="doc-navigation"> |
| <div class="doc-menu" role="navigation"> |
| <div class="navbar-header"> |
| <button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| </div> |
| <div class="navbar-collapse collapse sidebar-navbar-collapse"> |
| <form id="doc-search-form" class="navbar-form" action="../search.html" method="get" role="search"> |
| <div class="form-group"> |
| <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs"> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </div> |
| </form> |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../cql/index.html">The Cassandra Query Language (CQL)</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../configuration/index.html">Configuring Cassandra</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Cassandra Tools</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="cqlsh.html">cqlsh: the CQL shell</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nodetool/nodetool.html">Nodetool</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nodetool/nodetool.html#usage">Usage</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/index.html">SSTable Tools</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cassandra_stress.html">Cassandra Stress</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Third-Party Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> |
| </ul> |
| |
| |
| |
| </div><!--/.nav-collapse --> |
| </div> |
| </div> |
| </div> |
| <div class="col-md-8"> |
| <div class="content doc-content"> |
| <div class="content-container"> |
| |
| <div class="section" id="cassandra-tools"> |
| <h1>Cassandra Tools<a class="headerlink" href="#cassandra-tools" title="Permalink to this headline">ΒΆ</a></h1> |
| <p>This section describes the command line tools provided with Apache Cassandra.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="cqlsh.html">cqlsh: the CQL shell</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="cqlsh.html#compatibility">Compatibility</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cqlsh.html#optional-dependencies">Optional Dependencies</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#pytz">pytz</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#cython">cython</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="cqlsh.html#cqlshrc">cqlshrc</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cqlsh.html#command-line-options">Command Line Options</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cqlsh.html#special-commands">Special Commands</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#consistency"><code class="docutils literal notranslate"><span class="pre">CONSISTENCY</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#serial-consistency"><code class="docutils literal notranslate"><span class="pre">SERIAL</span> <span class="pre">CONSISTENCY</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#show-version"><code class="docutils literal notranslate"><span class="pre">SHOW</span> <span class="pre">VERSION</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#show-host"><code class="docutils literal notranslate"><span class="pre">SHOW</span> <span class="pre">HOST</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#show-session"><code class="docutils literal notranslate"><span class="pre">SHOW</span> <span class="pre">SESSION</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#source"><code class="docutils literal notranslate"><span class="pre">SOURCE</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#capture"><code class="docutils literal notranslate"><span class="pre">CAPTURE</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#help"><code class="docutils literal notranslate"><span class="pre">HELP</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#tracing"><code class="docutils literal notranslate"><span class="pre">TRACING</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#paging"><code class="docutils literal notranslate"><span class="pre">PAGING</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#expand"><code class="docutils literal notranslate"><span class="pre">EXPAND</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#login"><code class="docutils literal notranslate"><span class="pre">LOGIN</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#exit"><code class="docutils literal notranslate"><span class="pre">EXIT</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#clear"><code class="docutils literal notranslate"><span class="pre">CLEAR</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#describe"><code class="docutils literal notranslate"><span class="pre">DESCRIBE</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#copy-to"><code class="docutils literal notranslate"><span class="pre">COPY</span> <span class="pre">TO</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cqlsh.html#copy-from"><code class="docutils literal notranslate"><span class="pre">COPY</span> <span class="pre">FROM</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="nodetool/nodetool.html">Nodetool</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="nodetool/nodetool.html#usage">Usage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="sstable/index.html">SSTable Tools</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstabledump.html">sstabledump</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstabledump.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstabledump.html#dump-entire-table">Dump entire table</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstabledump.html#dump-table-in-a-more-manageable-format">Dump table in a more manageable format</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstabledump.html#dump-only-keys">Dump only keys</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstabledump.html#dump-row-for-a-single-key">Dump row for a single key</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstabledump.html#exclude-a-key-or-keys-in-dump-of-rows">Exclude a key or keys in dump of rows</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstabledump.html#display-raw-timestamps">Display raw timestamps</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstabledump.html#display-internal-structure-in-output">Display internal structure in output</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstableexpiredblockers.html">sstableexpiredblockers</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableexpiredblockers.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableexpiredblockers.html#output-blocked-sstables">Output blocked sstables</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstablelevelreset.html">sstablelevelreset</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablelevelreset.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablelevelreset.html#table-not-found">Table not found</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablelevelreset.html#table-has-no-sstables">Table has no sstables</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablelevelreset.html#table-already-at-level-0">Table already at level 0</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablelevelreset.html#table-levels-reduced-to-0">Table levels reduced to 0</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstableloader.html">sstableloader</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableloader.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableloader.html#load-sstables-from-a-snapshot">Load sstables from a Snapshot</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableloader.html#use-a-config-file-for-ssl-clusters">Use a Config File for SSL Clusters</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableloader.html#hide-progress-output">Hide Progress Output</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableloader.html#get-more-detail">Get More Detail</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableloader.html#throttling-load">Throttling Load</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableloader.html#speeding-up-load">Speeding up Load</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstablemetadata.html">sstablemetadata</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablemetadata.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablemetadata.html#print-all-the-metadata">Print all the metadata</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablemetadata.html#specify-gc-grace-seconds">Specify gc grace seconds</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablemetadata.html#explanation-of-each-value-printed-above">Explanation of each value printed above</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstableofflinerelevel.html">sstableofflinerelevel</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableofflinerelevel.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableofflinerelevel.html#doing-a-dry-run">Doing a dry run</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableofflinerelevel.html#running-a-relevel">Running a relevel</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableofflinerelevel.html#keyspace-or-table-not-found">Keyspace or table not found</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstablerepairedset.html">sstablerepairedset</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablerepairedset.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablerepairedset.html#set-a-lot-of-sstables-to-unrepaired-status">Set a lot of sstables to unrepaired status</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablerepairedset.html#set-one-to-many-sstables-to-repaired-status">Set one to many sstables to repaired status</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablerepairedset.html#print-metadata-showing-repaired-status">Print metadata showing repaired status</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablerepairedset.html#using-command-in-a-script">Using command in a script</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstablescrub.html">sstablescrub</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablescrub.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablescrub.html#basic-scrub">Basic Scrub</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablescrub.html#scrub-without-validation">Scrub without Validation</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablescrub.html#skip-corrupted-counter-tables">Skip Corrupted Counter Tables</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablescrub.html#dealing-with-overflow-dates">Dealing with Overflow Dates</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablescrub.html#manifest-check">Manifest Check</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstablesplit.html">sstablesplit</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablesplit.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablesplit.html#split-a-file">Split a File</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablesplit.html#split-multiple-files">Split Multiple Files</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablesplit.html#attempt-to-split-a-small-file">Attempt to Split a Small File</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablesplit.html#split-a-file-into-specified-size">Split a File into Specified Size</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstablesplit.html#split-without-snapshot">Split Without Snapshot</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstableupgrade.html">sstableupgrade</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableupgrade.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableupgrade.html#rewrite-tables-to-the-current-cassandra-version">Rewrite tables to the current Cassandra version</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableupgrade.html#rewrite-tables-to-the-current-cassandra-version-and-keep-tables-in-old-version">Rewrite tables to the current Cassandra version, and keep tables in old version</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableupgrade.html#rewrite-a-snapshot-to-the-current-cassandra-version">Rewrite a snapshot to the current Cassandra version</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstableutil.html">sstableutil</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableutil.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableutil.html#list-all-sstables">List all sstables</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableutil.html#list-only-temporary-sstables">List only temporary sstables</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableutil.html#list-only-final-sstables">List only final sstables</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableutil.html#include-transaction-logs">Include transaction logs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableutil.html#clean-up-sstables">Clean up sstables</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="sstable/sstableverify.html">sstableverify</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableverify.html#usage">Usage</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableverify.html#basic-verification">Basic Verification</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableverify.html#extended-verification">Extended Verification</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="sstable/sstableverify.html#corrupted-file">Corrupted File</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="cassandra_stress.html">Cassandra Stress</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="cassandra_stress.html#usage">Usage</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cassandra_stress.html#user-mode">User mode</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="cassandra_stress.html#profile">Profile</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="cassandra_stress.html#lightweight-transaction-support">Lightweight transaction support</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="cassandra_stress.html#graphing">Graphing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cassandra_stress.html#faq">FAQ</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| |
| |
| <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> |
| |
| <a href="cqlsh.html" class="btn btn-default pull-right " role="button" title="cqlsh: the CQL shell" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> |
| |
| |
| <a href="../operating/hardware.html" class="btn btn-default" role="button" title="Hardware Choices" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
