cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>CompactionManager (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <div class="topNav"><a name="navbar_top">  </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">  </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/CompactionManager.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../index-all.html">Index</a></li> <li><a href="../../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/cassandra/db/compaction/CompactionIterable.Reducer.html" title="class in org.apache.cassandra.db.compaction"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.AllSSTableOpStatus.html" title="enum in org.apache.cassandra.db.compaction"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/compaction/CompactionManager.html" target="_top">Frames</a></li> <li><a href="CompactionManager.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#field_summary">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field_detail">Field</a> | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top">  </a></div>   <div class="header"> <div class="subTitle">org.apache.cassandra.db.compaction</div> <h2 title="Class CompactionManager" class="title">Class CompactionManager</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.compaction.CompactionManager</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">CompactionManager</span> extends java.lang.Object implements <a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></pre> <div class="block">A singleton which manages a private executor of ongoing compactions. <p/> Scheduling for compaction is accomplished by swapping sstables to be compacted into a set via DataTracker. New scheduling attempts will ignore currently compacting sstables.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="nested_class_summary">  </a> <h3>Nested Class Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.AllSSTableOpStatus.html" title="enum in org.apache.cassandra.db.compaction">CompactionManager.AllSSTableOpStatus</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static interface </code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction">CompactionManager.CompactionExecutorStatsCollector</a></strong></code> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="field_summary">  </a> <h3>Field Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#GC_ALL">GC_ALL</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html" title="class in org.apache.cassandra.db.compaction">CompactionManager</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#instance">instance</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.lang.ThreadLocal<java.lang.Boolean></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#isCompactionManager">isCompactionManager</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#MBEAN_OBJECT_NAME">MBEAN_OBJECT_NAME</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#NO_GC">NO_GC</a></strong></code> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_summary">  </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#CompactionManager()">CompactionManager</a></strong>()</code> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_summary">  </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/sstable/SSTableWriter.html" title="class in org.apache.cassandra.io.sstable">SSTableWriter</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#createWriter(org.apache.cassandra.db.ColumnFamilyStore,%20java.io.File,%20int,%20long,%20org.apache.cassandra.io.sstable.SSTableReader)">createWriter</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, java.io.File compactionFileLocation, int expectedBloomFilterSize, long repairedAt, <a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a> sstable)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#disableAutoCompaction()">disableAutoCompaction</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#forceUserDefinedCompaction(java.lang.String)">forceUserDefinedCompaction</a></strong>(java.lang.String dataFiles)</code> <div class="block">Triggers the compaction of user specified sstables.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getActiveCompactions()">getActiveCompactions</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>javax.management.openmbean.TabularData</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getCompactionHistory()">getCompactionHistory</a></strong>()</code> <div class="block">compaction history</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<java.util.Map<java.lang.String,java.lang.String>></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getCompactions()">getCompactions</a></strong>()</code> <div class="block">List of running compaction objects.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getCompactionSummary()">getCompactionSummary</a></strong>()</code> <div class="block">List of running compaction summary strings.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getCompletedTasks()">getCompletedTasks</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getCoreCompactorThreads()">getCoreCompactorThreads</a></strong>()</code> <div class="block">Returns core size of compaction thread pool</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getCoreValidationThreads()">getCoreValidationThreads</a></strong>()</code> <div class="block">Returns core size of validation thread pool</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getMaximumCompactorThreads()">getMaximumCompactorThreads</a></strong>()</code> <div class="block">Returns maximum size of compaction thread pool</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getMaximumValidatorThreads()">getMaximumValidatorThreads</a></strong>()</code> <div class="block">Returns size of validator thread pool</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getPendingTasks()">getPendingTasks</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>com.google.common.util.concurrent.RateLimiter</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getRateLimiter()">getRateLimiter</a></strong>()</code> <div class="block">Gets compaction rate limiter.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getTotalBytesCompacted()">getTotalBytesCompacted</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#getTotalCompactionsCompleted()">getTotalCompactionsCompleted</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#interruptCompactionFor(java.lang.Iterable,%20boolean)">interruptCompactionFor</a></strong>(java.lang.Iterable<<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>> columnFamilies, boolean interruptValidation)</code> <div class="block">Try to stop all of the compactions for given ColumnFamilies.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#isCompacting(java.lang.Iterable)">isCompacting</a></strong>(java.lang.Iterable<<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a>> cfses)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#performAnticompaction(org.apache.cassandra.db.ColumnFamilyStore,%20java.util.Collection,%20java.util.Collection,%20long)">performAnticompaction</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, java.util.Collection<<a href="../../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>> ranges, java.util.Collection<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> validatedForRepair, long repairedAt)</code> <div class="block">Make sure the {validatedForRepair} are marked for compaction before calling this.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.AllSSTableOpStatus.html" title="enum in org.apache.cassandra.db.compaction">CompactionManager.AllSSTableOpStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#performCleanup(org.apache.cassandra.db.ColumnFamilyStore)">performCleanup</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfStore)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#performMaximal(org.apache.cassandra.db.ColumnFamilyStore)">performMaximal</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfStore)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.AllSSTableOpStatus.html" title="enum in org.apache.cassandra.db.compaction">CompactionManager.AllSSTableOpStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#performScrub(org.apache.cassandra.db.ColumnFamilyStore,%20boolean)">performScrub</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, boolean skipCorrupted)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.AllSSTableOpStatus.html" title="enum in org.apache.cassandra.db.compaction">CompactionManager.AllSSTableOpStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#performSSTableRewrite(org.apache.cassandra.db.ColumnFamilyStore,%20boolean)">performSSTableRewrite</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, boolean excludeCurrentVersion)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#setCoreCompactorThreads(int)">setCoreCompactorThreads</a></strong>(int number)</code> <div class="block">Allows user to resize maximum size of the compaction thread pool.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#setCoreValidationThreads(int)">setCoreValidationThreads</a></strong>(int number)</code> <div class="block">Allows user to resize maximum size of the compaction thread pool.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#setMaximumCompactorThreads(int)">setMaximumCompactorThreads</a></strong>(int number)</code> <div class="block">Allows user to resize maximum size of the compaction thread pool.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#setMaximumValidatorThreads(int)">setMaximumValidatorThreads</a></strong>(int number)</code> <div class="block">Allows user to resize maximum size of the validator thread pool.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#stopCompaction(java.lang.String)">stopCompaction</a></strong>(java.lang.String type)</code> <div class="block">Stop all running compaction-like tasks having the provided <code>type</code>.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.concurrent.Future<?></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#submitAntiCompaction(org.apache.cassandra.db.ColumnFamilyStore,%20java.util.Collection,%20java.util.Collection,%20long)">submitAntiCompaction</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, java.util.Collection<<a href="../../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>> ranges, java.util.Collection<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> validatedForRepair, long repairedAt)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<java.util.concurrent.Future<?>></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#submitBackground(org.apache.cassandra.db.ColumnFamilyStore)">submitBackground</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs)</code> <div class="block">Call this whenever a compaction might be needed on the given columnfamily.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.concurrent.Future<?></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#submitCacheWrite(org.apache.cassandra.cache.AutoSavingCache.Writer)">submitCacheWrite</a></strong>(<a href="../../../../../org/apache/cassandra/cache/AutoSavingCache.Writer.html" title="class in org.apache.cassandra.cache">AutoSavingCache.Writer</a> writer)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.concurrent.Future<?></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#submitIndexBuild(org.apache.cassandra.db.index.SecondaryIndexBuilder)">submitIndexBuild</a></strong>(<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexBuilder.html" title="class in org.apache.cassandra.db.index">SecondaryIndexBuilder</a> builder)</code> <div class="block">Is not scheduled, because it is performing disjoint work from sstable compaction.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.concurrent.Future<?></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#submitMaximal(org.apache.cassandra.db.ColumnFamilyStore,%20int)">submitMaximal</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfStore, int gcBefore)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.concurrent.Future<?></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#submitUserDefined(org.apache.cassandra.db.ColumnFamilyStore,%20java.util.Collection,%20int)">submitUserDefined</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, java.util.Collection<<a href="../../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a>> dataFiles, int gcBefore)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.concurrent.Future<java.lang.Object></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html#submitValidation(org.apache.cassandra.db.ColumnFamilyStore,%20org.apache.cassandra.repair.Validator)">submitValidation</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfStore, <a href="../../../../../org/apache/cassandra/repair/Validator.html" title="class in org.apache.cassandra.repair">Validator</a> validator)</code> <div class="block">Does not mutate data, so is not scheduled.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">  </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field_detail">  </a> <h3>Field Detail</h3> <a name="MBEAN_OBJECT_NAME">  </a> <ul class="blockList"> <li class="blockList"> <h4>MBEAN_OBJECT_NAME</h4> <pre>public static final java.lang.String MBEAN_OBJECT_NAME</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.db.compaction.CompactionManager.MBEAN_OBJECT_NAME">Constant Field Values</a></dd></dl> </li> </ul> <a name="instance">  </a> <ul class="blockList"> <li class="blockList"> <h4>instance</h4> <pre>public static final <a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html" title="class in org.apache.cassandra.db.compaction">CompactionManager</a> instance</pre> </li> </ul> <a name="NO_GC">  </a> <ul class="blockList"> <li class="blockList"> <h4>NO_GC</h4> <pre>public static final int NO_GC</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.db.compaction.CompactionManager.NO_GC">Constant Field Values</a></dd></dl> </li> </ul> <a name="GC_ALL">  </a> <ul class="blockList"> <li class="blockList"> <h4>GC_ALL</h4> <pre>public static final int GC_ALL</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.db.compaction.CompactionManager.GC_ALL">Constant Field Values</a></dd></dl> </li> </ul> <a name="isCompactionManager">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>isCompactionManager</h4> <pre>public static final java.lang.ThreadLocal<java.lang.Boolean> isCompactionManager</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="CompactionManager()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>CompactionManager</h4> <pre>public CompactionManager()</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="getRateLimiter()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getRateLimiter</h4> <pre>public com.google.common.util.concurrent.RateLimiter getRateLimiter()</pre> <div class="block">Gets compaction rate limiter. When compaction_throughput_mb_per_sec is 0 or node is bootstrapping, this returns rate limiter with the rate of Double.MAX_VALUE bytes per second. Rate unit is bytes per sec.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>RateLimiter with rate limit set</dd></dl> </li> </ul> <a name="submitBackground(org.apache.cassandra.db.ColumnFamilyStore)">  </a> <ul class="blockList"> <li class="blockList"> <h4>submitBackground</h4> <pre>public java.util.List<java.util.concurrent.Future<?>> submitBackground(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs)</pre> <div class="block">Call this whenever a compaction might be needed on the given columnfamily. It's okay to over-call (within reason) if a call is unnecessary, it will turn into a no-op in the bucketing/candidate-scan phase.</div> </li> </ul> <a name="isCompacting(java.lang.Iterable)">  </a> <ul class="blockList"> <li class="blockList"> <h4>isCompacting</h4> <pre>public boolean isCompacting(java.lang.Iterable<<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a>> cfses)</pre> </li> </ul> <a name="performScrub(org.apache.cassandra.db.ColumnFamilyStore, boolean)">  </a> <ul class="blockList"> <li class="blockList"> <h4>performScrub</h4> <pre>public <a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.AllSSTableOpStatus.html" title="enum in org.apache.cassandra.db.compaction">CompactionManager.AllSSTableOpStatus</a> performScrub(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, boolean skipCorrupted) throws java.lang.InterruptedException, java.util.concurrent.ExecutionException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.InterruptedException</code></dd> <dd><code>java.util.concurrent.ExecutionException</code></dd></dl> </li> </ul> <a name="performSSTableRewrite(org.apache.cassandra.db.ColumnFamilyStore, boolean)">  </a> <ul class="blockList"> <li class="blockList"> <h4>performSSTableRewrite</h4> <pre>public <a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.AllSSTableOpStatus.html" title="enum in org.apache.cassandra.db.compaction">CompactionManager.AllSSTableOpStatus</a> performSSTableRewrite(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, boolean excludeCurrentVersion) throws java.lang.InterruptedException, java.util.concurrent.ExecutionException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.InterruptedException</code></dd> <dd><code>java.util.concurrent.ExecutionException</code></dd></dl> </li> </ul> <a name="performCleanup(org.apache.cassandra.db.ColumnFamilyStore)">  </a> <ul class="blockList"> <li class="blockList"> <h4>performCleanup</h4> <pre>public <a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.AllSSTableOpStatus.html" title="enum in org.apache.cassandra.db.compaction">CompactionManager.AllSSTableOpStatus</a> performCleanup(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfStore) throws java.lang.InterruptedException, java.util.concurrent.ExecutionException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.InterruptedException</code></dd> <dd><code>java.util.concurrent.ExecutionException</code></dd></dl> </li> </ul> <a name="submitAntiCompaction(org.apache.cassandra.db.ColumnFamilyStore, java.util.Collection, java.util.Collection, long)">  </a> <ul class="blockList"> <li class="blockList"> <h4>submitAntiCompaction</h4> <pre>public java.util.concurrent.Future<?> submitAntiCompaction(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, java.util.Collection<<a href="../../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>> ranges, java.util.Collection<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> validatedForRepair, long repairedAt)</pre> </li> </ul> <a name="performAnticompaction(org.apache.cassandra.db.ColumnFamilyStore, java.util.Collection, java.util.Collection, long)">  </a> <ul class="blockList"> <li class="blockList"> <h4>performAnticompaction</h4> <pre>public void performAnticompaction(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, java.util.Collection<<a href="../../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>> ranges, java.util.Collection<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> validatedForRepair, long repairedAt) throws java.lang.InterruptedException, java.util.concurrent.ExecutionException, java.io.IOException</pre> <div class="block">Make sure the {validatedForRepair} are marked for compaction before calling this.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cfs</code> - </dd><dd><code>ranges</code> - Ranges that the repair was carried out on</dd><dd><code>validatedForRepair</code> - SSTables containing the repaired ranges. Should be referenced before passing them.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>InterruptedException,</code> - ExecutionException, IOException</dd> <dd><code>java.lang.InterruptedException</code></dd> <dd><code>java.util.concurrent.ExecutionException</code></dd> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="performMaximal(org.apache.cassandra.db.ColumnFamilyStore)">  </a> <ul class="blockList"> <li class="blockList"> <h4>performMaximal</h4> <pre>public void performMaximal(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfStore) throws java.lang.InterruptedException, java.util.concurrent.ExecutionException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.InterruptedException</code></dd> <dd><code>java.util.concurrent.ExecutionException</code></dd></dl> </li> </ul> <a name="submitMaximal(org.apache.cassandra.db.ColumnFamilyStore, int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>submitMaximal</h4> <pre>public java.util.concurrent.Future<?> submitMaximal(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfStore, int gcBefore)</pre> </li> </ul> <a name="forceUserDefinedCompaction(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>forceUserDefinedCompaction</h4> <pre>public void forceUserDefinedCompaction(java.lang.String dataFiles)</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#forceUserDefinedCompaction(java.lang.String)">CompactionManagerMBean</a></code></strong></div> <div class="block">Triggers the compaction of user specified sstables. You can specify files from various keyspaces and columnfamilies. If you do so, user defined compaction is performed several times to the groups of files in the same keyspace/columnfamily.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#forceUserDefinedCompaction(java.lang.String)">forceUserDefinedCompaction</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>dataFiles</code> - a comma separated list of sstable filename to compact</dd></dl> </li> </ul> <a name="submitUserDefined(org.apache.cassandra.db.ColumnFamilyStore, java.util.Collection, int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>submitUserDefined</h4> <pre>public java.util.concurrent.Future<?> submitUserDefined(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, java.util.Collection<<a href="../../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a>> dataFiles, int gcBefore)</pre> </li> </ul> <a name="submitValidation(org.apache.cassandra.db.ColumnFamilyStore, org.apache.cassandra.repair.Validator)">  </a> <ul class="blockList"> <li class="blockList"> <h4>submitValidation</h4> <pre>public java.util.concurrent.Future<java.lang.Object> submitValidation(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfStore, <a href="../../../../../org/apache/cassandra/repair/Validator.html" title="class in org.apache.cassandra.repair">Validator</a> validator)</pre> <div class="block">Does not mutate data, so is not scheduled.</div> </li> </ul> <a name="disableAutoCompaction()">  </a> <ul class="blockList"> <li class="blockList"> <h4>disableAutoCompaction</h4> <pre>public void disableAutoCompaction()</pre> </li> </ul> <a name="createWriter(org.apache.cassandra.db.ColumnFamilyStore, java.io.File, int, long, org.apache.cassandra.io.sstable.SSTableReader)">  </a> <ul class="blockList"> <li class="blockList"> <h4>createWriter</h4> <pre>public static <a href="../../../../../org/apache/cassandra/io/sstable/SSTableWriter.html" title="class in org.apache.cassandra.io.sstable">SSTableWriter</a> createWriter(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs, java.io.File compactionFileLocation, int expectedBloomFilterSize, long repairedAt, <a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a> sstable)</pre> </li> </ul> <a name="submitIndexBuild(org.apache.cassandra.db.index.SecondaryIndexBuilder)">  </a> <ul class="blockList"> <li class="blockList"> <h4>submitIndexBuild</h4> <pre>public java.util.concurrent.Future<?> submitIndexBuild(<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexBuilder.html" title="class in org.apache.cassandra.db.index">SecondaryIndexBuilder</a> builder)</pre> <div class="block">Is not scheduled, because it is performing disjoint work from sstable compaction.</div> </li> </ul> <a name="submitCacheWrite(org.apache.cassandra.cache.AutoSavingCache.Writer)">  </a> <ul class="blockList"> <li class="blockList"> <h4>submitCacheWrite</h4> <pre>public java.util.concurrent.Future<?> submitCacheWrite(<a href="../../../../../org/apache/cassandra/cache/AutoSavingCache.Writer.html" title="class in org.apache.cassandra.cache">AutoSavingCache.Writer</a> writer)</pre> </li> </ul> <a name="getActiveCompactions()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getActiveCompactions</h4> <pre>public int getActiveCompactions()</pre> </li> </ul> <a name="getCompactions()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCompactions</h4> <pre>public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getCompactions()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getCompactions()">CompactionManagerMBean</a></code></strong></div> <div class="block">List of running compaction objects.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getCompactions()">getCompactions</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></code></dd> </dl> </li> </ul> <a name="getCompactionSummary()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCompactionSummary</h4> <pre>public java.util.List<java.lang.String> getCompactionSummary()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getCompactionSummary()">CompactionManagerMBean</a></code></strong></div> <div class="block">List of running compaction summary strings.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getCompactionSummary()">getCompactionSummary</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></code></dd> </dl> </li> </ul> <a name="getCompactionHistory()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCompactionHistory</h4> <pre>public javax.management.openmbean.TabularData getCompactionHistory()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getCompactionHistory()">CompactionManagerMBean</a></code></strong></div> <div class="block">compaction history</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getCompactionHistory()">getCompactionHistory</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></code></dd> </dl> </li> </ul> <a name="getTotalBytesCompacted()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalBytesCompacted</h4> <pre>public long getTotalBytesCompacted()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getTotalBytesCompacted()">getTotalBytesCompacted</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>total number of bytes compacted since server [re]start</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/cassandra/metrics/CompactionMetrics.html#bytesCompacted"><code>CompactionMetrics.bytesCompacted</code></a></dd></dl> </li> </ul> <a name="getTotalCompactionsCompleted()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalCompactionsCompleted</h4> <pre>public long getTotalCompactionsCompleted()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getTotalCompactionsCompleted()">getTotalCompactionsCompleted</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>total number of compactions since server [re]start</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/cassandra/metrics/CompactionMetrics.html#totalCompactionsCompleted"><code>CompactionMetrics.totalCompactionsCompleted</code></a></dd></dl> </li> </ul> <a name="getPendingTasks()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getPendingTasks</h4> <pre>public int getPendingTasks()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getPendingTasks()">getPendingTasks</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>estimated number of compactions remaining to perform</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/cassandra/metrics/CompactionMetrics.html#pendingTasks"><code>CompactionMetrics.pendingTasks</code></a></dd></dl> </li> </ul> <a name="getCompletedTasks()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCompletedTasks</h4> <pre>public long getCompletedTasks()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getCompletedTasks()">getCompletedTasks</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>number of completed compactions since server [re]start</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/cassandra/metrics/CompactionMetrics.html#completedTasks"><code>CompactionMetrics.completedTasks</code></a></dd></dl> </li> </ul> <a name="stopCompaction(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>stopCompaction</h4> <pre>public void stopCompaction(java.lang.String type)</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#stopCompaction(java.lang.String)">CompactionManagerMBean</a></code></strong></div> <div class="block">Stop all running compaction-like tasks having the provided <code>type</code>.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#stopCompaction(java.lang.String)">stopCompaction</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html" title="interface in org.apache.cassandra.db.compaction">CompactionManagerMBean</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the type of compaction to stop. Ca