UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

498 lines (497 loc) 20.4 kB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:28 CEST 2014 --> <title>Memtable (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"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="Memtable (apache-cassandra API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <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/Memtable.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/KeyspaceNotDefinedException.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/MigrationRequestVerbHandler.html" title="class in org.apache.cassandra.db"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/db/Memtable.html" target="_top">Frames</a></li> <li><a href="Memtable.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"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">org.apache.cassandra.db</div> <h2 title="Class Memtable" class="title">Class Memtable</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.Memtable</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">Memtable</span> extends java.lang.Object</pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <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">&nbsp;</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><a href="../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#cfs">cfs</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/composites/CellNameType.html" title="interface in org.apache.cassandra.db.composites">CellNameType</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#initialComparator">initialComparator</a></strong></code>&nbsp;</td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <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">&nbsp;</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/Memtable.html#Memtable(org.apache.cassandra.db.ColumnFamilyStore)">Memtable</a></strong>(<a href="../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a>&nbsp;cfs)</code>&nbsp;</td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <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">&nbsp;</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>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#accepts(org.apache.cassandra.utils.concurrent.OpOrder.Group)">accepts</a></strong>(<a href="../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a>&nbsp;opGroup)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#contents()">contents</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#creationTime()">creationTime</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>org.apache.cassandra.db.Memtable.FlushRunnable</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#flushRunnable()">flushRunnable</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/utils/memory/MemtableAllocator.html" title="class in org.apache.cassandra.utils.memory">MemtableAllocator</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#getAllocator()">getAllocator</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#getColumnFamily(org.apache.cassandra.db.DecoratedKey)">getColumnFamily</a></strong>(<a href="../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a>&nbsp;key)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Iterator&lt;java.util.Map.Entry&lt;<a href="../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a>,<a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a>&gt;&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#getEntryIterator(org.apache.cassandra.db.RowPosition,%20org.apache.cassandra.db.RowPosition)">getEntryIterator</a></strong>(<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>&nbsp;startWith, <a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>&nbsp;stopAt)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/commitlog/ReplayPosition.html" title="class in org.apache.cassandra.db.commitlog">ReplayPosition</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#getLastReplayPosition()">getLastReplayPosition</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#getLiveDataSize()">getLiveDataSize</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#getOperations()">getOperations</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#isClean()">isClean</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#isCleanAfter(org.apache.cassandra.db.commitlog.ReplayPosition)">isCleanAfter</a></strong>(<a href="../../../../org/apache/cassandra/db/commitlog/ReplayPosition.html" title="class in org.apache.cassandra.db.commitlog">ReplayPosition</a>&nbsp;position)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#isExpired()">isExpired</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#isLive()">isLive</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/Memtable.html#toString()">toString</a></strong>()</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class&nbsp;java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="cfs"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>cfs</h4> <pre>public final&nbsp;<a href="../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs</pre> </li> </ul> <a name="initialComparator"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>initialComparator</h4> <pre>public final&nbsp;<a href="../../../../org/apache/cassandra/db/composites/CellNameType.html" title="interface in org.apache.cassandra.db.composites">CellNameType</a> initialComparator</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="Memtable(org.apache.cassandra.db.ColumnFamilyStore)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Memtable</h4> <pre>public&nbsp;Memtable(<a href="../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a>&nbsp;cfs)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getAllocator()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getAllocator</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/utils/memory/MemtableAllocator.html" title="class in org.apache.cassandra.utils.memory">MemtableAllocator</a>&nbsp;getAllocator()</pre> </li> </ul> <a name="getLiveDataSize()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLiveDataSize</h4> <pre>public&nbsp;long&nbsp;getLiveDataSize()</pre> </li> </ul> <a name="getOperations()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOperations</h4> <pre>public&nbsp;long&nbsp;getOperations()</pre> </li> </ul> <a name="accepts(org.apache.cassandra.utils.concurrent.OpOrder.Group)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>accepts</h4> <pre>public&nbsp;boolean&nbsp;accepts(<a href="../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a>&nbsp;opGroup)</pre> </li> </ul> <a name="isLive()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isLive</h4> <pre>public&nbsp;boolean&nbsp;isLive()</pre> </li> </ul> <a name="isClean()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isClean</h4> <pre>public&nbsp;boolean&nbsp;isClean()</pre> </li> </ul> <a name="isCleanAfter(org.apache.cassandra.db.commitlog.ReplayPosition)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isCleanAfter</h4> <pre>public&nbsp;boolean&nbsp;isCleanAfter(<a href="../../../../org/apache/cassandra/db/commitlog/ReplayPosition.html" title="class in org.apache.cassandra.db.commitlog">ReplayPosition</a>&nbsp;position)</pre> </li> </ul> <a name="isExpired()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isExpired</h4> <pre>public&nbsp;boolean&nbsp;isExpired()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>true if this memtable is expired. Expiration time is determined by CF's memtable_flush_period_in_ms.</dd></dl> </li> </ul> <a name="contents()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>contents</h4> <pre>public&nbsp;java.lang.String&nbsp;contents()</pre> </li> </ul> <a name="flushRunnable()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>flushRunnable</h4> <pre>public&nbsp;org.apache.cassandra.db.Memtable.FlushRunnable&nbsp;flushRunnable()</pre> </li> </ul> <a name="toString()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="getEntryIterator(org.apache.cassandra.db.RowPosition, org.apache.cassandra.db.RowPosition)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getEntryIterator</h4> <pre>public&nbsp;java.util.Iterator&lt;java.util.Map.Entry&lt;<a href="../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a>,<a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a>&gt;&gt;&nbsp;getEntryIterator(<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>&nbsp;startWith, <a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>&nbsp;stopAt)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>startWith</code> - Include data in the result from and including this key and to the end of the memtable</dd> <dt><span class="strong">Returns:</span></dt><dd>An iterator of entries with the data from the start key</dd></dl> </li> </ul> <a name="getColumnFamily(org.apache.cassandra.db.DecoratedKey)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getColumnFamily</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a>&nbsp;getColumnFamily(<a href="../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a>&nbsp;key)</pre> </li> </ul> <a name="creationTime()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>creationTime</h4> <pre>public&nbsp;long&nbsp;creationTime()</pre> </li> </ul> <a name="getLastReplayPosition()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getLastReplayPosition</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/db/commitlog/ReplayPosition.html" title="class in org.apache.cassandra.db.commitlog">ReplayPosition</a>&nbsp;getLastReplayPosition()</pre> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <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/Memtable.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/KeyspaceNotDefinedException.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/MigrationRequestVerbHandler.html" title="class in org.apache.cassandra.db"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/db/Memtable.html" target="_top">Frames</a></li> <li><a href="Memtable.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"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright &copy; 2014 The Apache Software Foundation</small></p> </body> </html>