blob: f0b41454420159afd13e584fb6f157b00bcac65c [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>SSTable Tools &mdash; Apache Cassandra Documentation v4.0-rc2</title>
<script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/extra.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="sstabledump" href="sstabledump.html" />
<link rel="prev" title="Nodetool" href="../nodetool/nodetool.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> Apache Cassandra
</a>
<div class="version">
4.0-rc2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<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="../../new/index.html">New Features in Apache Cassandra 4.0</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="../../cql/index.html">The Cassandra Query Language (CQL)</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="../../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="reference internal" href="../index.html">Cassandra Tools</a><ul class="current">
<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="../generatetokens.html">generatetokens</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 current"><a class="current reference internal" href="#">SSTable Tools</a><ul>
<li class="toctree-l3"><a class="reference internal" href="sstabledump.html">sstabledump</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstableexpiredblockers.html">sstableexpiredblockers</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstablelevelreset.html">sstablelevelreset</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstableloader.html">sstableloader</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstablemetadata.html">sstablemetadata</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstableofflinerelevel.html">sstableofflinerelevel</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstablerepairedset.html">sstablerepairedset</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstablescrub.html">sstablescrub</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstablesplit.html">sstablesplit</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstableupgrade.html">sstableupgrade</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstableutil.html">sstableutil</a></li>
<li class="toctree-l3"><a class="reference internal" href="sstableverify.html">sstableverify</a></li>
</ul>
</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>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">Apache Cassandra</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Cassandra Tools</a> &raquo;</li>
<li>SSTable Tools</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/tools/sstable/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="sstable-tools">
<h1>SSTable Tools<a class="headerlink" href="#sstable-tools" title="Permalink to this headline">¶</a></h1>
<p>This section describes the functionality of the various sstable tools.</p>
<p>Cassandra must be stopped before these tools are executed, or unexpected results will occur. Note: the scripts do not verify that Cassandra is stopped.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="sstabledump.html">sstabledump</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstabledump.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstabledump.html#dump-entire-table">Dump entire table</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstabledump.html#dump-table-in-a-more-manageable-format">Dump table in a more manageable format</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstabledump.html#dump-only-keys">Dump only keys</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstabledump.html#dump-row-for-a-single-key">Dump row for a single key</a></li>
<li class="toctree-l2"><a class="reference internal" href="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-l2"><a class="reference internal" href="sstabledump.html#display-raw-timestamps">Display raw timestamps</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstabledump.html#display-internal-structure-in-output">Display internal structure in output</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sstableexpiredblockers.html">sstableexpiredblockers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstableexpiredblockers.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableexpiredblockers.html#output-blocked-sstables">Output blocked sstables</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sstablelevelreset.html">sstablelevelreset</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstablelevelreset.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablelevelreset.html#table-not-found">Table not found</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablelevelreset.html#table-has-no-sstables">Table has no sstables</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablelevelreset.html#table-already-at-level-0">Table already at level 0</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablelevelreset.html#table-levels-reduced-to-0">Table levels reduced to 0</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sstableloader.html">sstableloader</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstableloader.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableloader.html#load-sstables-from-a-snapshot">Load sstables from a Snapshot</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableloader.html#use-a-config-file-for-ssl-clusters">Use a Config File for SSL Clusters</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableloader.html#hide-progress-output">Hide Progress Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableloader.html#get-more-detail">Get More Detail</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableloader.html#throttling-load">Throttling Load</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableloader.html#speeding-up-load">Speeding up Load</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sstablemetadata.html">sstablemetadata</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstablemetadata.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablemetadata.html#print-all-the-metadata">Print all the metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablemetadata.html#specify-gc-grace-seconds">Specify gc grace seconds</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablemetadata.html#explanation-of-each-value-printed-above">Explanation of each value printed above</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sstableofflinerelevel.html">sstableofflinerelevel</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstableofflinerelevel.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableofflinerelevel.html#doing-a-dry-run">Doing a dry run</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableofflinerelevel.html#running-a-relevel">Running a relevel</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableofflinerelevel.html#keyspace-or-table-not-found">Keyspace or table not found</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sstablerepairedset.html">sstablerepairedset</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstablerepairedset.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablerepairedset.html#set-a-lot-of-sstables-to-unrepaired-status">Set a lot of sstables to unrepaired status</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablerepairedset.html#set-one-to-many-sstables-to-repaired-status">Set one to many sstables to repaired status</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablerepairedset.html#print-metadata-showing-repaired-status">Print metadata showing repaired status</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablerepairedset.html#using-command-in-a-script">Using command in a script</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sstablescrub.html">sstablescrub</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstablescrub.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablescrub.html#basic-scrub">Basic Scrub</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablescrub.html#scrub-without-validation">Scrub without Validation</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablescrub.html#skip-corrupted-counter-tables">Skip Corrupted Counter Tables</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablescrub.html#dealing-with-overflow-dates">Dealing with Overflow Dates</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablescrub.html#manifest-check">Manifest Check</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sstablesplit.html">sstablesplit</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstablesplit.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablesplit.html#split-a-file">Split a File</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablesplit.html#split-multiple-files">Split Multiple Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablesplit.html#attempt-to-split-a-small-file">Attempt to Split a Small File</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablesplit.html#split-a-file-into-specified-size">Split a File into Specified Size</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstablesplit.html#split-without-snapshot">Split Without Snapshot</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sstableupgrade.html">sstableupgrade</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstableupgrade.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableupgrade.html#rewrite-tables-to-the-current-cassandra-version">Rewrite tables to the current Cassandra version</a></li>
<li class="toctree-l2"><a class="reference internal" href="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-l2"><a class="reference internal" href="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-l1"><a class="reference internal" href="sstableutil.html">sstableutil</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstableutil.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableutil.html#list-all-sstables">List all sstables</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableutil.html#list-only-temporary-sstables">List only temporary sstables</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableutil.html#list-only-final-sstables">List only final sstables</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableutil.html#include-transaction-logs">Include transaction logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableutil.html#clean-up-sstables">Clean up sstables</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sstableverify.html">sstableverify</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sstableverify.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableverify.html#basic-verification">Basic Verification</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableverify.html#extended-verification">Extended Verification</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstableverify.html#corrupted-file">Corrupted File</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="sstabledump.html" class="btn btn-neutral float-right" title="sstabledump" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../nodetool/nodetool.html" class="btn btn-neutral float-left" title="Nodetool" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, The Apache Cassandra team
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>