UNPKG

cassandra-server

Version:

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

373 lines (369 loc) 15.1 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:31 CEST 2014 --> <title>Downsampling (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="Downsampling (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/Downsampling.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/Descriptor.Version.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/IndexHelper.html" title="class 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/Downsampling.html" target="_top">Frames</a></li> <li><a href="Downsampling.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.io.sstable</div> <h2 title="Class Downsampling" class="title">Class Downsampling</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.io.sstable.Downsampling</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">Downsampling</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>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Downsampling.html#BASE_SAMPLING_LEVEL">BASE_SAMPLING_LEVEL</a></strong></code> <div class="block">The base (down)sampling level determines the granularity at which we can down/upsample.</div> </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/io/sstable/Downsampling.html#Downsampling()">Downsampling</a></strong>()</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>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Downsampling.html#getEffectiveIndexIntervalAfterIndex(int,%20int,%20int)">getEffectiveIndexIntervalAfterIndex</a></strong>(int&nbsp;index, int&nbsp;samplingLevel, int&nbsp;minIndexInterval)</code> <div class="block">Calculates the effective index interval after the entry at `index` in an IndexSummary.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.util.List&lt;java.lang.Integer&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Downsampling.html#getOriginalIndexes(int)">getOriginalIndexes</a></strong>(int&nbsp;samplingLevel)</code> <div class="block">Returns a list that can be used to translate current index summary indexes to their original index before downsampling.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.util.List&lt;java.lang.Integer&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Downsampling.html#getSamplingPattern(int)">getSamplingPattern</a></strong>(int&nbsp;samplingLevel)</code> <div class="block">Gets a list L of starting indices for downsampling rounds: the first round should start with the offset given by L[0], the second by the offset in L[1], etc.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static int[]</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Downsampling.html#getStartPoints(int,%20int)">getStartPoints</a></strong>(int&nbsp;currentSamplingLevel, int&nbsp;newSamplingLevel)</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, toString, 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="BASE_SAMPLING_LEVEL"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>BASE_SAMPLING_LEVEL</h4> <pre>public static final&nbsp;int BASE_SAMPLING_LEVEL</pre> <div class="block">The base (down)sampling level determines the granularity at which we can down/upsample. A higher number allows us to approximate more closely the ideal sampling. (It could also mean we do a lot of expensive almost-no-op resamplings from N to N-1, but the thresholds in IndexSummaryManager prevent that.) BSL must be a power of two in order to have good sampling patterns. This cannot be changed without rebuilding all index summaries at full sampling; for now we treat it as a constant.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.io.sstable.Downsampling.BASE_SAMPLING_LEVEL">Constant Field Values</a></dd></dl> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="Downsampling()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Downsampling</h4> <pre>public&nbsp;Downsampling()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getSamplingPattern(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSamplingPattern</h4> <pre>public static&nbsp;java.util.List&lt;java.lang.Integer&gt;&nbsp;getSamplingPattern(int&nbsp;samplingLevel)</pre> <div class="block">Gets a list L of starting indices for downsampling rounds: the first round should start with the offset given by L[0], the second by the offset in L[1], etc.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>samplingLevel</code> - the base sampling level</dd> <dt><span class="strong">Returns:</span></dt><dd>A list of `samplingLevel` unique indices between 0 and `samplingLevel`</dd></dl> </li> </ul> <a name="getOriginalIndexes(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOriginalIndexes</h4> <pre>public static&nbsp;java.util.List&lt;java.lang.Integer&gt;&nbsp;getOriginalIndexes(int&nbsp;samplingLevel)</pre> <div class="block">Returns a list that can be used to translate current index summary indexes to their original index before downsampling. (This repeats every `samplingLevel`, so that's how many entries we return.) For example, if [7, 15] is returned, the current index summary entry at index 0 was originally at index 7, and the current index 1 was originally at index 15.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>samplingLevel</code> - the current sampling level for the index summary</dd> <dt><span class="strong">Returns:</span></dt><dd>a list of original indexes for current summary entries</dd></dl> </li> </ul> <a name="getEffectiveIndexIntervalAfterIndex(int, int, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getEffectiveIndexIntervalAfterIndex</h4> <pre>public static&nbsp;int&nbsp;getEffectiveIndexIntervalAfterIndex(int&nbsp;index, int&nbsp;samplingLevel, int&nbsp;minIndexInterval)</pre> <div class="block">Calculates the effective index interval after the entry at `index` in an IndexSummary. In other words, this returns the number of partitions in the primary on-disk index before the next partition that has an entry in the index summary. If samplingLevel == BASE_SAMPLING_LEVEL, this will be equal to the index interval.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - an index into an IndexSummary</dd><dd><code>samplingLevel</code> - the current sampling level for that IndexSummary</dd><dd><code>minIndexInterval</code> - the min index interval (effective index interval at full sampling)</dd> <dt><span class="strong">Returns:</span></dt><dd>the number of partitions before the next index summary entry, inclusive on one end</dd></dl> </li> </ul> <a name="getStartPoints(int, int)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getStartPoints</h4> <pre>public static&nbsp;int[]&nbsp;getStartPoints(int&nbsp;currentSamplingLevel, int&nbsp;newSamplingLevel)</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/Downsampling.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/Descriptor.Version.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/IndexHelper.html" title="class 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/Downsampling.html" target="_top">Frames</a></li> <li><a href="Downsampling.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>