org.apache.cassandra.db.index

Class SecondaryIndexManager

java.lang.Object

org.apache.cassandra.db.index.SecondaryIndexManager

public class SecondaryIndexManager
extends java.lang.Object

Manages all the indexes associated with a given CFS Different types of indexes can be created across the same CF

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SecondaryIndexManager.Updater

Field Summary

Fields

Modifier and Type	Field and Description
ColumnFamilyStore	baseCfs The underlying column family containing the source data for these indexes
static SecondaryIndexManager.Updater	nullUpdater

Constructor Summary

Constructors

Constructor and Description
SecondaryIndexManager(ColumnFamilyStore baseCfs)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Future<?>	addIndexedColumn(ColumnDefinition cdef) Adds and builds a index for a column
java.util.Set<java.lang.String>	allIndexesNames()
void	deleteFromIndexes(UnfilteredRowIterator partition, OpOrder.Group opGroup, int nowInSec) Delete all data from all indexes for this partition.
void	flushIndexesBlocking() Flush all indexes to disk
SecondaryIndexManager.Updater	gcUpdaterFor(DecoratedKey key, int nowInSec) Updated closure with only the modified row key.
SecondaryIndexSearcher	getBestIndexSearcherFor(ReadCommand command)
java.util.List<java.lang.String>	getBuiltIndexes()
SecondaryIndex	getIndexByName(java.lang.String idxName)
java.util.Set<SecondaryIndex>	getIndexes()
java.util.Set<ColumnFamilyStore>	getIndexesBackedByCfs()
java.util.Set<SecondaryIndex>	getIndexesByNames(java.util.Set<java.lang.String> idxNames)
java.util.Set<SecondaryIndex>	getIndexesNotBackedByCfs()
SecondaryIndex	getIndexForColumn(ColumnDefinition column)
java.util.List<SecondaryIndexSearcher>	getIndexSearchersFor(ReadCommand command) Get a list of IndexSearchers from the union of expression index types
boolean	hasIndexes()
boolean	indexes(ColumnDefinition column)
void	indexPartition(UnfilteredRowIterator partition, OpOrder.Group opGroup, java.util.Set<SecondaryIndex> allIndexes, int nowInSec) When building an index against existing data, add the given partition to the index
void	invalidate() Remove the index
void	maybeBuildSecondaryIndexes(java.util.Collection<SSTableReader> sstables, java.util.Set<java.lang.String> idxNames) Does a full, blocking rebuild of the indexes specified by columns from the sstables.
java.util.Set<PerColumnSecondaryIndex>	perColumnIndexes()
java.util.Set<PerRowSecondaryIndex>	perRowIndexes()
void	reload() Drops and adds new indexes associated with the underlying CF
void	removeIndexedColumn(java.nio.ByteBuffer column) Removes a existing index
void	setIndexBuilt(java.util.Set<java.lang.String> idxNames)
void	setIndexRemoved(java.util.Set<java.lang.String> idxNames)
SecondaryIndexManager.Updater	updaterFor(PartitionUpdate update, OpOrder.Group opGroup, int nowInSec) This helper acts as a closure around the indexManager and updated data to ensure that down in Memtable's ColumnFamily implementation, the index can get updated.
void	validate(Clustering clustering)
void	validate(ColumnDefinition column, java.nio.ByteBuffer value, CellPath path)
void	validate(DecoratedKey partitionKey)
void	validateFilter(RowFilter filter) Validates an union of expression index types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nullUpdater

public static final SecondaryIndexManager.Updater nullUpdater

baseCfs

public final ColumnFamilyStore baseCfs

The underlying column family containing the source data for these indexes

Constructor Detail

SecondaryIndexManager

public SecondaryIndexManager(ColumnFamilyStore baseCfs)

Method Detail

reload

public void reload()

Drops and adds new indexes associated with the underlying CF

allIndexesNames

public java.util.Set<java.lang.String> allIndexesNames()

perColumnIndexes

public java.util.Set<PerColumnSecondaryIndex> perColumnIndexes()

perRowIndexes

public java.util.Set<PerRowSecondaryIndex> perRowIndexes()

maybeBuildSecondaryIndexes

public void maybeBuildSecondaryIndexes(java.util.Collection<SSTableReader> sstables,
                                       java.util.Set<java.lang.String> idxNames)

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.

Parameters:

sstables - the data to build from

idxNames - the list of columns to index, ordered by comparator

indexes

public boolean indexes(ColumnDefinition column)

removeIndexedColumn

public void removeIndexedColumn(java.nio.ByteBuffer column)

Removes a existing index

Parameters:

column - the indexed column to remove

addIndexedColumn

public java.util.concurrent.Future<?> addIndexedColumn(ColumnDefinition cdef)

Adds and builds a index for a column

Parameters:

cdef - the column definition holding the index data

Returns:

a future which the caller can optionally block on signaling the index is built

getIndexForColumn

public SecondaryIndex getIndexForColumn(ColumnDefinition column)

Parameters:

column - the name of indexes column

Returns:

the index

invalidate

public void invalidate()

Remove the index

flushIndexesBlocking

public void flushIndexesBlocking()

Flush all indexes to disk

getBuiltIndexes

public java.util.List<java.lang.String> getBuiltIndexes()

Returns:

all built indexes (ready to use)

getIndexesBackedByCfs

public java.util.Set<ColumnFamilyStore> getIndexesBackedByCfs()

Returns:

all CFS from indexes which use a backing CFS internally (KEYS)

getIndexesNotBackedByCfs

public java.util.Set<SecondaryIndex> getIndexesNotBackedByCfs()

Returns:

all indexes which do *not* use a backing CFS internally

getIndexes

public java.util.Set<SecondaryIndex> getIndexes()

Returns:

all of the secondary indexes without distinction to the (non-)backed by secondary ColumnFamilyStore.

hasIndexes

public boolean hasIndexes()

Returns:

if there are ANY indexes for this table..

indexPartition

public void indexPartition(UnfilteredRowIterator partition,
                           OpOrder.Group opGroup,
                           java.util.Set<SecondaryIndex> allIndexes,
                           int nowInSec)

When building an index against existing data, add the given partition to the index

deleteFromIndexes

public void deleteFromIndexes(UnfilteredRowIterator partition,
                              OpOrder.Group opGroup,
                              int nowInSec)

Delete all data from all indexes for this partition. For when cleanup rips a partition out entirely.

updaterFor

public SecondaryIndexManager.Updater updaterFor(PartitionUpdate update,
                                                OpOrder.Group opGroup,
                                                int nowInSec)

This helper acts as a closure around the indexManager and updated data to ensure that down in Memtable's ColumnFamily implementation, the index can get updated.

gcUpdaterFor

public SecondaryIndexManager.Updater gcUpdaterFor(DecoratedKey key,
                                                  int nowInSec)

Updated closure with only the modified row key.

getIndexSearchersFor

public java.util.List<SecondaryIndexSearcher> getIndexSearchersFor(ReadCommand command)

Get a list of IndexSearchers from the union of expression index types

Parameters:

command - the query

Returns:

the searchers needed to query the index

getBestIndexSearcherFor

public SecondaryIndexSearcher getBestIndexSearcherFor(ReadCommand command)

validateFilter

public void validateFilter(RowFilter filter)
                    throws InvalidRequestException

Validates an union of expression index types. It will throw an InvalidRequestException if any of the expressions in the provided clause is not valid for its index implementation.

Parameters:

filter - the filter to check

Throws:

InvalidRequestException - in case of validation errors

getIndexesByNames

public java.util.Set<SecondaryIndex> getIndexesByNames(java.util.Set<java.lang.String> idxNames)

getIndexByName

public SecondaryIndex getIndexByName(java.lang.String idxName)

setIndexBuilt

public void setIndexBuilt(java.util.Set<java.lang.String> idxNames)

setIndexRemoved

public void setIndexRemoved(java.util.Set<java.lang.String> idxNames)

validate

public void validate(DecoratedKey partitionKey)
              throws InvalidRequestException

Throws:

InvalidRequestException

validate

public void validate(Clustering clustering)
              throws InvalidRequestException

Throws:

InvalidRequestException

validate

public void validate(ColumnDefinition column,
                     java.nio.ByteBuffer value,
                     CellPath path)
              throws InvalidRequestException

Throws:

InvalidRequestException