cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
777 lines (775 loc) • 42 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>SecondaryIndexManager (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="SecondaryIndexManager (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/SecondaryIndexManager.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/SecondaryIndexBuilder.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/SecondaryIndexManager.Updater.html" title="interface 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/SecondaryIndexManager.html" target="_top">Frames</a></li>
<li><a href="SecondaryIndexManager.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><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">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><a href="#field_detail">Field</a> | </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 SecondaryIndexManager" class="title">Class SecondaryIndexManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.db.index.SecondaryIndexManager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">SecondaryIndexManager</span>
extends java.lang.Object</pre>
<div class="block">Manages all the indexes associated with a given CFS
Different types of indexes can be created across the same CF</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.Updater.html" title="interface in org.apache.cassandra.db.index">SecondaryIndexManager.Updater</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- =========== 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"> </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/index/SecondaryIndexManager.html#baseCfs">baseCfs</a></strong></code>
<div class="block">The underlying column family containing the source data for these indexes</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.Updater.html" title="interface in org.apache.cassandra.db.index">SecondaryIndexManager.Updater</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#nullUpdater">nullUpdater</a></strong></code> </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"> </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/SecondaryIndexManager.html#SecondaryIndexManager(org.apache.cassandra.db.ColumnFamilyStore)">SecondaryIndexManager</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> baseCfs)</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>java.util.concurrent.Future<?></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#addIndexedColumn(org.apache.cassandra.config.ColumnDefinition)">addIndexedColumn</a></strong>(<a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a> cdef)</code>
<div class="block">Adds and builds a index for a column</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set<java.lang.String></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#allIndexesNames()">allIndexesNames</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#deleteFromIndexes(org.apache.cassandra.db.DecoratedKey,%20java.util.List,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">deleteFromIndexes</a></strong>(<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
java.util.List<<a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>> indexedColumnsInRow,
<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">Delete all columns from all indexes for this row.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#flushIndexesBlocking()">flushIndexesBlocking</a></strong>()</code>
<div class="block">Flush all indexes to disk</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.Updater.html" title="interface in org.apache.cassandra.db.index">SecondaryIndexManager.Updater</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#gcUpdaterFor(org.apache.cassandra.db.DecoratedKey)">gcUpdaterFor</a></strong>(<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key)</code>
<div class="block">Updated closure with only the modified row key.</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/index/SecondaryIndexManager.html#getBuiltIndexes()">getBuiltIndexes</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#getIndexes()">getIndexes</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set<<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/index/SecondaryIndexManager.html#getIndexesBackedByCfs()">getIndexesBackedByCfs</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#getIndexesByNames(java.util.Set)">getIndexesByNames</a></strong>(java.util.Set<java.lang.String> idxNames)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#getIndexesNotBackedByCfs()">getIndexesNotBackedByCfs</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#getIndexForColumn(java.nio.ByteBuffer)">getIndexForColumn</a></strong>(java.nio.ByteBuffer column)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html" title="class in org.apache.cassandra.db.index">SecondaryIndexSearcher</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#getIndexSearchersForQuery(java.util.List)">getIndexSearchersForQuery</a></strong>(java.util.List<<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>> clause)</code>
<div class="block">Get a list of IndexSearchers from the union of expression index types</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#hasIndexes()">hasIndexes</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#hasIndexFor(java.util.List)">hasIndexFor</a></strong>(java.util.List<<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>> clause)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#indexes(org.apache.cassandra.db.Cell)">indexes</a></strong>(<a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#indexes(org.apache.cassandra.db.composites.CellName)">indexes</a></strong>(<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> name)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#indexes(org.apache.cassandra.db.composites.CellName,%20java.util.Set)">indexes</a></strong>(<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> name,
java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>> indexes)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#indexFor(org.apache.cassandra.db.composites.CellName)">indexFor</a></strong>(<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> name)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#indexFor(org.apache.cassandra.db.composites.CellName,%20java.util.Set)">indexFor</a></strong>(<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> name,
java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>> indexes)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#indexRow(java.nio.ByteBuffer,%20org.apache.cassandra.db.ColumnFamily,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">indexRow</a></strong>(java.nio.ByteBuffer key,
<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf,
<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">When building an index against existing data, add the given row to the index</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#invalidate()">invalidate</a></strong>()</code>
<div class="block">Remove the index</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#maybeBuildSecondaryIndexes(java.util.Collection,%20java.util.Set)">maybeBuildSecondaryIndexes</a></strong>(java.util.Collection<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> sstables,
java.util.Set<java.lang.String> idxNames)</code>
<div class="block">Does a full, blocking rebuild of the indexes specified by columns from the sstables.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#reload()">reload</a></strong>()</code>
<div class="block">Drops and adds new indexes associated with the underlying CF</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#removeIndexedColumn(java.nio.ByteBuffer)">removeIndexedColumn</a></strong>(java.nio.ByteBuffer column)</code>
<div class="block">Removes a existing index</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#search(org.apache.cassandra.db.filter.ExtendedFilter)">search</a></strong>(<a href="../../../../../org/apache/cassandra/db/filter/ExtendedFilter.html" title="class in org.apache.cassandra.db.filter">ExtendedFilter</a> filter)</code>
<div class="block">Performs a search across a number of column indexes</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#setIndexBuilt(java.util.Set)">setIndexBuilt</a></strong>(java.util.Set<java.lang.String> idxNames)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#setIndexRemoved(java.util.Set)">setIndexRemoved</a></strong>(java.util.Set<java.lang.String> idxNames)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.Updater.html" title="interface in org.apache.cassandra.db.index">SecondaryIndexManager.Updater</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html#updaterFor(org.apache.cassandra.db.DecoratedKey,%20org.apache.cassandra.db.ColumnFamily,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">updaterFor</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/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf,
<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">This helper acts as a closure around the indexManager
and updated cf data to ensure that down in
Memtable's ColumnFamily implementation, the index
can get updated.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.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_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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="nullUpdater">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nullUpdater</h4>
<pre>public static final <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.Updater.html" title="interface in org.apache.cassandra.db.index">SecondaryIndexManager.Updater</a> nullUpdater</pre>
</li>
</ul>
<a name="baseCfs">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>baseCfs</h4>
<pre>public final <a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> baseCfs</pre>
<div class="block">The underlying column family containing the source data for these indexes</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SecondaryIndexManager(org.apache.cassandra.db.ColumnFamilyStore)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SecondaryIndexManager</h4>
<pre>public SecondaryIndexManager(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> baseCfs)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="reload()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reload</h4>
<pre>public void reload()</pre>
<div class="block">Drops and adds new indexes associated with the underlying CF</div>
</li>
</ul>
<a name="allIndexesNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allIndexesNames</h4>
<pre>public java.util.Set<java.lang.String> allIndexesNames()</pre>
</li>
</ul>
<a name="maybeBuildSecondaryIndexes(java.util.Collection, java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maybeBuildSecondaryIndexes</h4>
<pre>public void maybeBuildSecondaryIndexes(java.util.Collection<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>> sstables,
java.util.Set<java.lang.String> idxNames)</pre>
<div class="block">Does a full, blocking rebuild of the indexes specified by columns from the sstables.
Does nothing if columns is empty.
Caller must acquire and release references to the sstables used here.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sstables</code> - the data to build from</dd><dd><code>idxNames</code> - the list of columns to index, ordered by comparator</dd></dl>
</li>
</ul>
<a name="indexes(org.apache.cassandra.db.composites.CellName, java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexes</h4>
<pre>public boolean indexes(<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> name,
java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>> indexes)</pre>
</li>
</ul>
<a name="indexFor(org.apache.cassandra.db.composites.CellName, java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexFor</h4>
<pre>public java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>> indexFor(<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> name,
java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>> indexes)</pre>
</li>
</ul>
<a name="indexes(org.apache.cassandra.db.Cell)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexes</h4>
<pre>public boolean indexes(<a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell)</pre>
</li>
</ul>
<a name="indexes(org.apache.cassandra.db.composites.CellName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexes</h4>
<pre>public boolean indexes(<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> name)</pre>
</li>
</ul>
<a name="indexFor(org.apache.cassandra.db.composites.CellName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexFor</h4>
<pre>public java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>> indexFor(<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> name)</pre>
</li>
</ul>
<a name="hasIndexFor(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasIndexFor</h4>
<pre>public boolean hasIndexFor(java.util.List<<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>> clause)</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if at least one of the indexes can handle the clause.</dd></dl>
</li>
</ul>
<a name="removeIndexedColumn(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeIndexedColumn</h4>
<pre>public void removeIndexedColumn(java.nio.ByteBuffer column)</pre>
<div class="block">Removes a existing index</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - the indexed column to remove</dd></dl>
</li>
</ul>
<a name="addIndexedColumn(org.apache.cassandra.config.ColumnDefinition)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addIndexedColumn</h4>
<pre>public java.util.concurrent.Future<?> addIndexedColumn(<a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a> cdef)</pre>
<div class="block">Adds and builds a index for a column</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cdef</code> - the column definition holding the index data</dd>
<dt><span class="strong">Returns:</span></dt><dd>a future which the caller can optionally block on signaling the index is built</dd></dl>
</li>
</ul>
<a name="getIndexForColumn(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexForColumn</h4>
<pre>public <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a> getIndexForColumn(java.nio.ByteBuffer column)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - the name of indexes column</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index</dd></dl>
</li>
</ul>
<a name="invalidate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invalidate</h4>
<pre>public void invalidate()</pre>
<div class="block">Remove the index</div>
</li>
</ul>
<a name="flushIndexesBlocking()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flushIndexesBlocking</h4>
<pre>public void flushIndexesBlocking()</pre>
<div class="block">Flush all indexes to disk</div>
</li>
</ul>
<a name="getBuiltIndexes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuiltIndexes</h4>
<pre>public java.util.List<java.lang.String> getBuiltIndexes()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>all built indexes (ready to use)</dd></dl>
</li>
</ul>
<a name="getIndexesBackedByCfs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexesBackedByCfs</h4>
<pre>public java.util.Set<<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a>> getIndexesBackedByCfs()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>all CFS from indexes which use a backing CFS internally (KEYS)</dd></dl>
</li>
</ul>
<a name="getIndexesNotBackedByCfs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexesNotBackedByCfs</h4>
<pre>public java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>> getIndexesNotBackedByCfs()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>all indexes which do *not* use a backing CFS internally</dd></dl>
</li>
</ul>
<a name="getIndexes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexes</h4>
<pre>public java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>> getIndexes()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>all of the secondary indexes without distinction to the (non-)backed by secondary ColumnFamilyStore.</dd></dl>
</li>
</ul>
<a name="hasIndexes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasIndexes</h4>
<pre>public boolean hasIndexes()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>if there are ANY indexes for this table..</dd></dl>
</li>
</ul>
<a name="indexRow(java.nio.ByteBuffer, org.apache.cassandra.db.ColumnFamily, org.apache.cassandra.utils.concurrent.OpOrder.Group)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexRow</h4>
<pre>public void indexRow(java.nio.ByteBuffer key,
<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf,
<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">When building an index against existing data, add the given row to the index</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the row key</dd><dd><code>cf</code> - the current rows data</dd></dl>
</li>
</ul>
<a name="deleteFromIndexes(org.apache.cassandra.db.DecoratedKey, java.util.List, org.apache.cassandra.utils.concurrent.OpOrder.Group)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteFromIndexes</h4>
<pre>public void deleteFromIndexes(<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
java.util.List<<a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>> indexedColumnsInRow,
<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">Delete all columns from all indexes for this row. For when cleanup rips a row out entirely.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the row key</dd><dd><code>indexedColumnsInRow</code> - all column names in row</dd></dl>
</li>
</ul>
<a name="updaterFor(org.apache.cassandra.db.DecoratedKey, org.apache.cassandra.db.ColumnFamily, org.apache.cassandra.utils.concurrent.OpOrder.Group)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updaterFor</h4>
<pre>public <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.Updater.html" title="interface in org.apache.cassandra.db.index">SecondaryIndexManager.Updater</a> updaterFor(<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf,
<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">This helper acts as a closure around the indexManager
and updated cf data to ensure that down in
Memtable's ColumnFamily implementation, the index
can get updated. Note: only a CF backed by AtomicSortedColumns implements
this behaviour fully, other types simply ignore the index updater.</div>
</li>
</ul>
<a name="gcUpdaterFor(org.apache.cassandra.db.DecoratedKey)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>gcUpdaterFor</h4>
<pre>public <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.Updater.html" title="interface in org.apache.cassandra.db.index">SecondaryIndexManager.Updater</a> gcUpdaterFor(<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key)</pre>
<div class="block">Updated closure with only the modified row key.</div>
</li>
</ul>
<a name="getIndexSearchersForQuery(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexSearchersForQuery</h4>
<pre>public java.util.List<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html" title="class in org.apache.cassandra.db.index">SecondaryIndexSearcher</a>> getIndexSearchersForQuery(java.util.List<<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>> clause)</pre>
<div class="block">Get a list of IndexSearchers from the union of expression index types</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>clause</code> - the query clause</dd>
<dt><span class="strong">Returns:</span></dt><dd>the searchers needed to query the index</dd></dl>
</li>
</ul>
<a name="search(org.apache.cassandra.db.filter.ExtendedFilter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>search</h4>
<pre>public java.util.List<<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>> search(<a href="../../../../../org/apache/cassandra/db/filter/ExtendedFilter.html" title="class in org.apache.cassandra.db.filter">ExtendedFilter</a> filter)</pre>
<div class="block">Performs a search across a number of column indexes</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - the column range to restrict to</dd>
<dt><span class="strong">Returns:</span></dt><dd>found indexed rows</dd></dl>
</li>
</ul>
<a name="getIndexesByNames(java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexesByNames</h4>
<pre>public java.util.Set<<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a>> getIndexesByNames(java.util.Set<java.lang.String> idxNames)</pre>
</li>
</ul>
<a name="setIndexBuilt(java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndexBuilt</h4>
<pre>public void setIndexBuilt(java.util.Set<java.lang.String> idxNames)</pre>
</li>
</ul>
<a name="setIndexRemoved(java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndexRemoved</h4>
<pre>public void setIndexRemoved(java.util.Set<java.lang.String> idxNames)</pre>
</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>
</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/SecondaryIndexManager.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/SecondaryIndexBuilder.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/SecondaryIndexManager.Updater.html" title="interface 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/SecondaryIndexManager.html" target="_top">Frames</a></li>
<li><a href="SecondaryIndexManager.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><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">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><a href="#field_detail">Field</a> | </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>