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>IndexSummaryManager (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/IndexSummaryManager.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/io/sstable/IndexSummaryBuilder.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/io/sstable/IndexSummaryManager.html" target="_top">Frames</a></li> <li><a href="IndexSummaryManager.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><a href="#field_summary">Field</a> | </li> <li>Constr | </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>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.io.sstable</div> <h2 title="Class IndexSummaryManager" class="title">Class IndexSummaryManager</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.io.sstable.IndexSummaryManager</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/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable">IndexSummaryManagerMBean</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">IndexSummaryManager</span> extends java.lang.Object implements <a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable">IndexSummaryManagerMBean</a></pre> <div class="block">Manages the fixed-size memory pool for index summaries, periodically resizing them in order to give more memory to hot sstables and less memory to cold sstables.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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 <a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html" title="class in org.apache.cassandra.io.sstable">IndexSummaryManager</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html#instance">instance</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/io/sstable/IndexSummaryManager.html#MBEAN_NAME">MBEAN_NAME</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>double</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html#getAverageIndexInterval()">getAverageIndexInterval</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Integer></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html#getIndexIntervals()">getIndexIntervals</a></strong>()</code> <div class="block">Returns a map of SSTable filenames to their current effective index interval.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html#getMemoryPoolCapacityInMB()">getMemoryPoolCapacityInMB</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>double</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html#getMemoryPoolSizeInMB()">getMemoryPoolSizeInMB</a></strong>()</code> <div class="block">Returns the actual space consumed by index summaries for all sstables.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html#getResizeIntervalInMinutes()">getResizeIntervalInMinutes</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html#redistributeSummaries()">redistributeSummaries</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.util.List<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html#redistributeSummaries(java.util.List,%20java.util.List,%20long)">redistributeSummaries</a></strong>(java.util.List<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> compacting, java.util.List<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> nonCompacting, long memoryPoolBytes)</code> <div class="block">Attempts to fairly distribute a fixed pool of memory for index summaries across a set of SSTables based on their recent read rates.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html#setMemoryPoolCapacityInMB(long)">setMemoryPoolCapacityInMB</a></strong>(long memoryPoolCapacityInMB)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html#setResizeIntervalInMinutes(int)">setResizeIntervalInMinutes</a></strong>(int resizeIntervalInMinutes)</code> </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_NAME">  </a> <ul class="blockList"> <li class="blockList"> <h4>MBEAN_NAME</h4> <pre>public static final java.lang.String MBEAN_NAME</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.io.sstable.IndexSummaryManager.MBEAN_NAME">Constant Field Values</a></dd></dl> </li> </ul> <a name="instance">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>instance</h4> <pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManager.html" title="class in org.apache.cassandra.io.sstable">IndexSummaryManager</a> instance</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="getResizeIntervalInMinutes()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getResizeIntervalInMinutes</h4> <pre>public int getResizeIntervalInMinutes()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html#getResizeIntervalInMinutes()">getResizeIntervalInMinutes</a></code> in interface <code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable">IndexSummaryManagerMBean</a></code></dd> </dl> </li> </ul> <a name="setResizeIntervalInMinutes(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setResizeIntervalInMinutes</h4> <pre>public void setResizeIntervalInMinutes(int resizeIntervalInMinutes)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html#setResizeIntervalInMinutes(int)">setResizeIntervalInMinutes</a></code> in interface <code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable">IndexSummaryManagerMBean</a></code></dd> </dl> </li> </ul> <a name="getMemoryPoolCapacityInMB()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getMemoryPoolCapacityInMB</h4> <pre>public long getMemoryPoolCapacityInMB()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html#getMemoryPoolCapacityInMB()">getMemoryPoolCapacityInMB</a></code> in interface <code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable">IndexSummaryManagerMBean</a></code></dd> </dl> </li> </ul> <a name="getIndexIntervals()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getIndexIntervals</h4> <pre>public java.util.Map<java.lang.String,java.lang.Integer> getIndexIntervals()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html#getIndexIntervals()">IndexSummaryManagerMBean</a></code></strong></div> <div class="block">Returns a map of SSTable filenames to their current effective index interval.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html#getIndexIntervals()">getIndexIntervals</a></code> in interface <code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable">IndexSummaryManagerMBean</a></code></dd> </dl> </li> </ul> <a name="getAverageIndexInterval()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getAverageIndexInterval</h4> <pre>public double getAverageIndexInterval()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html#getAverageIndexInterval()">getAverageIndexInterval</a></code> in interface <code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable">IndexSummaryManagerMBean</a></code></dd> </dl> </li> </ul> <a name="setMemoryPoolCapacityInMB(long)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setMemoryPoolCapacityInMB</h4> <pre>public void setMemoryPoolCapacityInMB(long memoryPoolCapacityInMB)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html#setMemoryPoolCapacityInMB(long)">setMemoryPoolCapacityInMB</a></code> in interface <code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable">IndexSummaryManagerMBean</a></code></dd> </dl> </li> </ul> <a name="getMemoryPoolSizeInMB()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getMemoryPoolSizeInMB</h4> <pre>public double getMemoryPoolSizeInMB()</pre> <div class="block">Returns the actual space consumed by index summaries for all sstables.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html#getMemoryPoolSizeInMB()">getMemoryPoolSizeInMB</a></code> in interface <code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable">IndexSummaryManagerMBean</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>space currently used in MB</dd></dl> </li> </ul> <a name="redistributeSummaries()">  </a> <ul class="blockList"> <li class="blockList"> <h4>redistributeSummaries</h4> <pre>public void redistributeSummaries() throws java.io.IOException</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html#redistributeSummaries()">redistributeSummaries</a></code> in interface <code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable">IndexSummaryManagerMBean</a></code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="redistributeSummaries(java.util.List, java.util.List, long)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>redistributeSummaries</h4> <pre>public static java.util.List<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> redistributeSummaries(java.util.List<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> compacting, java.util.List<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> nonCompacting, long memoryPoolBytes) throws java.io.IOException</pre> <div class="block">Attempts to fairly distribute a fixed pool of memory for index summaries across a set of SSTables based on their recent read rates.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>nonCompacting</code> - a list of sstables to share the memory pool across</dd><dd><code>memoryPoolBytes</code> - a size (in bytes) that the total index summary space usage should stay close to or under, if possible</dd> <dt><span class="strong">Returns:</span></dt><dd>a list of new SSTableReader instances</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></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/IndexSummaryManager.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/io/sstable/IndexSummaryBuilder.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummaryManagerMBean.html" title="interface in org.apache.cassandra.io.sstable"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/io/sstable/IndexSummaryManager.html" target="_top">Frames</a></li> <li><a href="IndexSummaryManager.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><a href="#field_summary">Field</a> | </li> <li>Constr | </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>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>