cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
352 lines (351 loc) • 18.4 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:26 CEST 2014 -->
<title>PerRowSecondaryIndex (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="PerRowSecondaryIndex (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/PerRowSecondaryIndex.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/index/PerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/db/index/PerRowSecondaryIndex.html" target="_top">Frames</a></li>
<li><a href="PerRowSecondaryIndex.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: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.cassandra.db.index.SecondaryIndex">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>Field | </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>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.db.index</div>
<h2 title="Class PerRowSecondaryIndex" class="title">Class PerRowSecondaryIndex</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">org.apache.cassandra.db.index.SecondaryIndex</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.db.index.PerRowSecondaryIndex</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="strong">PerRowSecondaryIndex</span>
extends <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></pre>
<div class="block">Base class for Secondary indexes that implement a unique index per row</div>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.db.index.SecondaryIndex">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.cassandra.db.index.<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></h3>
<code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#baseCfs">baseCfs</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#columnDefs">columnDefs</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#CUSTOM_INDEX_OPTION_NAME">CUSTOM_INDEX_OPTION_NAME</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#keyComparator">keyComparator</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#logger">logger</a></code></li>
</ul>
</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"> </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/index/PerRowSecondaryIndex.html#PerRowSecondaryIndex()">PerRowSecondaryIndex</a></strong>()</code> </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"> </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>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/PerRowSecondaryIndex.html#delete(org.apache.cassandra.db.DecoratedKey,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">delete</a></strong>(<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
<a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a> opGroup)</code>
<div class="block">cleans up deleted columns from cassandra cleanup compaction</div>
</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/index/PerRowSecondaryIndex.html#getNameForSystemKeyspace(java.nio.ByteBuffer)">getNameForSystemKeyspace</a></strong>(java.nio.ByteBuffer columnName)</code>
<div class="block">Return the unique name for this index and column
to be stored in the SystemKeyspace that tracks if each column is built</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/PerRowSecondaryIndex.html#index(java.nio.ByteBuffer,%20org.apache.cassandra.db.ColumnFamily)">index</a></strong>(java.nio.ByteBuffer rowKey,
<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf)</code>
<div class="block">Index the given row.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/PerRowSecondaryIndex.html#validate(org.apache.cassandra.db.Cell)">validate</a></strong>(<a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.index.SecondaryIndex">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.cassandra.db.index.<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></h3>
<code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#buildIndexAsync()">buildIndexAsync</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#buildIndexBlocking()">buildIndexBlocking</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#createInstance(org.apache.cassandra.db.ColumnFamilyStore,%20org.apache.cassandra.config.ColumnDefinition)">createInstance</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#createSecondaryIndexSearcher(java.util.Set)">createSecondaryIndexSearcher</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#estimateResultRows()">estimateResultRows</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#forceBlockingFlush()">forceBlockingFlush</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getBaseCfs()">getBaseCfs</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getColumnDefs()">getColumnDefs</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getIndexCfs()">getIndexCfs</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getIndexComparator(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.config.ColumnDefinition)">getIndexComparator</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getIndexKeyFor(java.nio.ByteBuffer)">getIndexKeyFor</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getIndexName()">getIndexName</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#indexes(org.apache.cassandra.db.composites.CellName)">indexes</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#init()">init</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#invalidate()">invalidate</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#isIndexBuilt(java.nio.ByteBuffer)">isIndexBuilt</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#reload()">reload</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#removeIndex(java.nio.ByteBuffer)">removeIndex</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#setIndexBuilt()">setIndexBuilt</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#setIndexRemoved()">setIndexRemoved</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#truncateBlocking(long)">truncateBlocking</a>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#validateOptions()">validateOptions</a></code></li>
</ul>
<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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PerRowSecondaryIndex()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PerRowSecondaryIndex</h4>
<pre>public PerRowSecondaryIndex()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="index(java.nio.ByteBuffer, org.apache.cassandra.db.ColumnFamily)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>index</h4>
<pre>public abstract void index(java.nio.ByteBuffer rowKey,
<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf)</pre>
<div class="block">Index the given row.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rowKey</code> - the row key</dd><dd><code>cf</code> - the cf data to be indexed</dd></dl>
</li>
</ul>
<a name="delete(org.apache.cassandra.db.DecoratedKey, org.apache.cassandra.utils.concurrent.OpOrder.Group)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delete</h4>
<pre>public abstract void delete(<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
<a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a> opGroup)</pre>
<div class="block">cleans up deleted columns from cassandra cleanup compaction</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - </dd></dl>
</li>
</ul>
<a name="getNameForSystemKeyspace(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameForSystemKeyspace</h4>
<pre>public java.lang.String getNameForSystemKeyspace(java.nio.ByteBuffer columnName)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getNameForSystemKeyspace(java.nio.ByteBuffer)">SecondaryIndex</a></code></strong></div>
<div class="block">Return the unique name for this index and column
to be stored in the SystemKeyspace that tracks if each column is built</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getNameForSystemKeyspace(java.nio.ByteBuffer)">getNameForSystemKeyspace</a></code> in class <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>columnName</code> - the name of the column</dd>
<dt><span class="strong">Returns:</span></dt><dd>the unique name</dd></dl>
</li>
</ul>
<a name="validate(org.apache.cassandra.db.Cell)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>validate</h4>
<pre>public boolean validate(<a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#validate(org.apache.cassandra.db.Cell)">validate</a></code> in class <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></dd>
</dl>
</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/PerRowSecondaryIndex.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/index/PerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/db/index/PerRowSecondaryIndex.html" target="_top">Frames</a></li>
<li><a href="PerRowSecondaryIndex.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: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.cassandra.db.index.SecondaryIndex">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>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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 © 2014 The Apache Software Foundation</small></p>
</body>
</html>