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>CompactionManagerMBean (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/CompactionManagerMBean.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/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/compaction/CompactionTask.html" title="class 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/CompactionManagerMBean.html" target="_top">Frames</a></li> <li><a href="CompactionManagerMBean.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>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </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="Interface CompactionManagerMBean" class="title">Interface CompactionManagerMBean</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.html" title="class in org.apache.cassandra.db.compaction">CompactionManager</a></dd> </dl> <hr> <br> <pre>public interface <span class="strong">CompactionManagerMBean</span></pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.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>javax.management.openmbean.TabularData</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getCompactionHistory()">getCompactionHistory</a></strong>()</code> <div class="block">compaction history</div> </td> </tr> <tr class="altColor"> <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/CompactionManagerMBean.html#getCompactions()">getCompactions</a></strong>()</code> <div class="block">List of running compaction objects.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.html#getCompactionSummary()">getCompactionSummary</a></strong>()</code> <div class="block">List of running compaction summary strings.</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/CompactionManagerMBean.html#getCompletedTasks()">getCompletedTasks</a></strong>()</code> <div class="block"><strong>Deprecated.</strong> </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/CompactionManagerMBean.html#getCoreCompactorThreads()">getCoreCompactorThreads</a></strong>()</code> <div class="block">Returns core size of compaction 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/CompactionManagerMBean.html#getCoreValidationThreads()">getCoreValidationThreads</a></strong>()</code> <div class="block">Returns core size of validation 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/CompactionManagerMBean.html#getMaximumCompactorThreads()">getMaximumCompactorThreads</a></strong>()</code> <div class="block">Returns maximum size of compaction 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/CompactionManagerMBean.html#getMaximumValidatorThreads()">getMaximumValidatorThreads</a></strong>()</code> <div class="block">Returns size of validator 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/CompactionManagerMBean.html#getPendingTasks()">getPendingTasks</a></strong>()</code> <div class="block"><strong>Deprecated.</strong> </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/CompactionManagerMBean.html#getTotalBytesCompacted()">getTotalBytesCompacted</a></strong>()</code> <div class="block"><strong>Deprecated.</strong> </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/CompactionManagerMBean.html#getTotalCompactionsCompleted()">getTotalCompactionsCompleted</a></strong>()</code> <div class="block"><strong>Deprecated.</strong> </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/CompactionManagerMBean.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="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.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="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.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="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.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="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionManagerMBean.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> </table> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="getCompactions()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCompactions</h4> <pre>java.util.List<java.util.Map<java.lang.String,java.lang.String>> getCompactions()</pre> <div class="block">List of running compaction objects.</div> </li> </ul> <a name="getCompactionSummary()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCompactionSummary</h4> <pre>java.util.List<java.lang.String> getCompactionSummary()</pre> <div class="block">List of running compaction summary strings.</div> </li> </ul> <a name="getCompactionHistory()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCompactionHistory</h4> <pre>javax.management.openmbean.TabularData getCompactionHistory()</pre> <div class="block">compaction history</div> </li> </ul> <a name="getPendingTasks()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getPendingTasks</h4> <pre>@Deprecated int getPendingTasks()</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <dl><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>@Deprecated long getCompletedTasks()</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <dl><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="getTotalBytesCompacted()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalBytesCompacted</h4> <pre>@Deprecated long getTotalBytesCompacted()</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <dl><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>@Deprecated long getTotalCompactionsCompleted()</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <dl><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="forceUserDefinedCompaction(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>forceUserDefinedCompaction</h4> <pre>void forceUserDefinedCompaction(java.lang.String dataFiles)</pre> <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><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="stopCompaction(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>stopCompaction</h4> <pre>void stopCompaction(java.lang.String type)</pre> <div class="block">Stop all running compaction-like tasks having the provided <code>type</code>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the type of compaction to stop. Can be one of: - COMPACTION - VALIDATION - CLEANUP - SCRUB - INDEX_BUILD</dd></dl> </li> </ul> <a name="getCoreCompactorThreads()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCoreCompactorThreads</h4> <pre>int getCoreCompactorThreads()</pre> <div class="block">Returns core size of compaction thread pool</div> </li> </ul> <a name="setCoreCompactorThreads(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setCoreCompactorThreads</h4> <pre>void setCoreCompactorThreads(int number)</pre> <div class="block">Allows user to resize maximum size of the compaction thread pool.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>number</code> - New maximum of compaction threads</dd></dl> </li> </ul> <a name="getMaximumCompactorThreads()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getMaximumCompactorThreads</h4> <pre>int getMaximumCompactorThreads()</pre> <div class="block">Returns maximum size of compaction thread pool</div> </li> </ul> <a name="setMaximumCompactorThreads(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setMaximumCompactorThreads</h4> <pre>void setMaximumCompactorThreads(int number)</pre> <div class="block">Allows user to resize maximum size of the compaction thread pool.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>number</code> - New maximum of compaction threads</dd></dl> </li> </ul> <a name="getCoreValidationThreads()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCoreValidationThreads</h4> <pre>int getCoreValidationThreads()</pre> <div class="block">Returns core size of validation thread pool</div> </li> </ul> <a name="setCoreValidationThreads(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setCoreValidationThreads</h4> <pre>void setCoreValidationThreads(int number)</pre> <div class="block">Allows user to resize maximum size of the compaction thread pool.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>number</code> - New maximum of compaction threads</dd></dl> </li> </ul> <a name="getMaximumValidatorThreads()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getMaximumValidatorThreads</h4> <pre>int getMaximumValidatorThreads()</pre> <div class="block">Returns size of validator thread pool</div> </li> </ul> <a name="setMaximumValidatorThreads(int)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>setMaximumValidatorThreads</h4> <pre>void setMaximumValidatorThreads(int number)</pre> <div class="block">Allows user to resize maximum size of the validator thread pool.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>number</code> - New maximum of validator threads</dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <div class="bottomNav"><a name="navbar_bottom">  </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_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/CompactionManagerMBean.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/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/compaction/CompactionTask.html" title="class 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/CompactionManagerMBean.html" target="_top">Frames</a></li> <li><a href="CompactionManagerMBean.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <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>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom">  </a></div>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>