blob: d6625f409b201c58ab4dc5ee0cc10e64148e8ff8 [file] [log] [blame]
---
layout: docpage
title: "Documentation"
is_homepage: false
is_sphinx_doc: true
doc-parent: "Cassandra Tools"
doc-parent: "SSTable Tools"
doc-title: "sstableofflinerelevel"
doc-header-links: '
<link rel="top" title="Apache Cassandra Documentation v4.0-beta4" href="../../index.html"/>
<link rel="up" title="SSTable Tools" href="index.html"/>
<link rel="next" title="sstablerepairedset" href="sstablerepairedset.html"/>
<link rel="prev" title="sstablemetadata" href="sstablemetadata.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="../../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="../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="reference internal" href="index.html">SSTable Tools</a><ul class="current">
<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 current"><a class="current reference internal" href="#">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><!--/.nav-collapse -->
</div>
</div>
</div>
<div class="col-md-8">
<div class="content doc-content">
<div class="content-container">
<div class="section" id="sstableofflinerelevel">
<h1>sstableofflinerelevel<a class="headerlink" href="#sstableofflinerelevel" title="Permalink to this headline"></a></h1>
<p>When using LeveledCompactionStrategy, sstables can get stuck at L0 on a recently bootstrapped node, and compactions may never catch up. This tool is used to bump sstables into the highest level possible.</p>
<p>ref: <a class="reference external" href="https://issues.apache.org/jira/browse/CASSANDRA-8301">https://issues.apache.org/jira/browse/CASSANDRA-8301</a></p>
<p>The way this is done is: sstables are storted by their last token. Given an original leveling like this (note that [ ] indicates token boundaries, not sstable size on disk; all sstables are the same size):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">L3</span> <span class="p">[][][][][][][][][][][]</span>
<span class="n">L2</span> <span class="p">[</span> <span class="p">][</span> <span class="p">][</span> <span class="p">][</span> <span class="p">]</span>
<span class="n">L1</span> <span class="p">[</span> <span class="p">][</span> <span class="p">]</span>
<span class="n">L0</span> <span class="p">[</span> <span class="p">]</span>
</pre></div>
</div>
<p>Will look like this after being dropped to L0 and sorted by last token (and, to illustrate overlap, the overlapping ones are put on a new line):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[][][]</span>
<span class="p">[</span> <span class="p">][][][]</span>
<span class="p">[</span> <span class="p">]</span>
<span class="p">[</span> <span class="p">]</span>
<span class="o">...</span>
</pre></div>
</div>
<p>Then, we start iterating from the smallest last-token and adding all sstables that do not cause an overlap to a level. We will reconstruct the original leveling top-down. Whenever we add an sstable to the level, we remove it from the sorted list. Once we reach the end of the sorted list, we have a full level, and can start over with the level below.</p>
<p>If we end up with more levels than expected, we put all levels exceeding the expected in L0, for example, original L0 files will most likely be put in a level of its own since they most often overlap many other sstables.</p>
<p>Cassandra must be stopped before this tool is executed, or unexpected results will occur. Note: the script does not verify that Cassandra is stopped.</p>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<p>sstableofflinerelevel [–dry-run] &lt;keyspace&gt; &lt;table&gt;</p>
</div>
<div class="section" id="doing-a-dry-run">
<h2>Doing a dry run<a class="headerlink" href="#doing-a-dry-run" title="Permalink to this headline"></a></h2>
<p>Use the –dry-run option to see the current level distribution and predicted level after the change.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sstableofflinerelevel</span> <span class="o">--</span><span class="n">dry</span><span class="o">-</span><span class="n">run</span> <span class="n">keyspace</span> <span class="n">eventlog</span>
<span class="n">For</span> <span class="n">sstables</span> <span class="ow">in</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">cassandra</span><span class="o">/</span><span class="n">data</span><span class="o">/</span><span class="n">keyspace</span><span class="o">/</span><span class="n">eventlog</span><span class="o">-</span><span class="mi">6365332094</span><span class="n">dd11e88f324f9c503e4753</span><span class="p">:</span>
<span class="n">Current</span> <span class="n">leveling</span><span class="p">:</span>
<span class="n">L0</span><span class="o">=</span><span class="mi">2</span>
<span class="n">Potential</span> <span class="n">leveling</span><span class="p">:</span>
<span class="n">L0</span><span class="o">=</span><span class="mi">1</span>
<span class="n">L1</span><span class="o">=</span><span class="mi">1</span>
</pre></div>
</div>
</div>
<div class="section" id="running-a-relevel">
<h2>Running a relevel<a class="headerlink" href="#running-a-relevel" title="Permalink to this headline"></a></h2>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sstableofflinerelevel</span> <span class="n">keyspace</span> <span class="n">eventlog</span>
<span class="n">For</span> <span class="n">sstables</span> <span class="ow">in</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">cassandra</span><span class="o">/</span><span class="n">data</span><span class="o">/</span><span class="n">keyspace</span><span class="o">/</span><span class="n">eventlog</span><span class="o">-</span><span class="mi">6365332094</span><span class="n">dd11e88f324f9c503e4753</span><span class="p">:</span>
<span class="n">Current</span> <span class="n">leveling</span><span class="p">:</span>
<span class="n">L0</span><span class="o">=</span><span class="mi">2</span>
<span class="n">New</span> <span class="n">leveling</span><span class="p">:</span>
<span class="n">L0</span><span class="o">=</span><span class="mi">1</span>
<span class="n">L1</span><span class="o">=</span><span class="mi">1</span>
</pre></div>
</div>
</div>
<div class="section" id="keyspace-or-table-not-found">
<h2>Keyspace or table not found<a class="headerlink" href="#keyspace-or-table-not-found" title="Permalink to this headline"></a></h2>
<p>If an invalid keyspace and/or table is provided, an exception will be thrown.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sstableofflinerelevel</span> <span class="o">--</span><span class="n">dry</span><span class="o">-</span><span class="n">run</span> <span class="n">keyspace</span> <span class="n">evenlog</span>
<span class="ne">Exception</span> <span class="ow">in</span> <span class="n">thread</span> <span class="s2">&quot;main&quot;</span> <span class="n">java</span><span class="o">.</span><span class="n">lang</span><span class="o">.</span><span class="n">IllegalArgumentException</span><span class="p">:</span> <span class="n">Unknown</span> <span class="n">keyspace</span><span class="o">/</span><span class="n">columnFamily</span> <span class="n">keyspace1</span><span class="o">.</span><span class="n">evenlog</span>
<span class="n">at</span> <span class="n">org</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">cassandra</span><span class="o">.</span><span class="n">tools</span><span class="o">.</span><span class="n">SSTableOfflineRelevel</span><span class="o">.</span><span class="n">main</span><span class="p">(</span><span class="n">SSTableOfflineRelevel</span><span class="o">.</span><span class="n">java</span><span class="p">:</span><span class="mi">96</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="doc-prev-next-links" role="navigation" aria-label="footer navigation">
<a href="sstablerepairedset.html" class="btn btn-default pull-right " role="button" title="sstablerepairedset" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a>
<a href="sstablemetadata.html" class="btn btn-default" role="button" title="sstablemetadata" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
</div>
</div>
</div>
</div>
</div>
</div>