org.apache.cassandra.db.index

Class PerColumnSecondaryIndex

java.lang.Object

org.apache.cassandra.db.index.SecondaryIndex

org.apache.cassandra.db.index.PerColumnSecondaryIndex

Direct Known Subclasses:

AbstractSimplePerColumnSecondaryIndex

public abstract class PerColumnSecondaryIndex
extends SecondaryIndex

Base class for Secondary indexes that implement a unique index per column

Field Summary

Fields inherited from class org.apache.cassandra.db.index.SecondaryIndex

baseCfs, columnDefs, CUSTOM_INDEX_OPTION_NAME, INDEX_ENTRIES_OPTION_NAME, INDEX_KEYS_OPTION_NAME, INDEX_VALUES_OPTION_NAME, keyComparator, logger

Constructor Summary

Constructors

Constructor and Description
PerColumnSecondaryIndex()

Method Summary

Modifier and Type	Method and Description
abstract void	delete(java.nio.ByteBuffer rowKey, Clustering clustering, Cell cell, OpOrder.Group opGroup, int nowInSec) Called when a column has been tombstoned or replaced.
abstract void	deleteForCleanup(java.nio.ByteBuffer rowKey, Clustering clustering, Cell cell, OpOrder.Group opGroup, int nowInSec) Called when a column has been removed due to a cleanup operation.
java.lang.String	getNameForSystemKeyspace(java.nio.ByteBuffer column) Return the unique name for this index and column to be stored in the SystemKeyspace that tracks if each column is built
protected boolean	indexPrimaryKeyColumn()
void	indexRow(DecoratedKey key, Row row, OpOrder.Group opGroup, int nowInSec)
abstract void	insert(java.nio.ByteBuffer rowKey, Clustering clustering, Cell cell, OpOrder.Group opGroup) insert a column to the index
void	maybeDelete(java.nio.ByteBuffer partitionKey, Clustering clustering, DeletionTime deletion, OpOrder.Group opGroup) For indexes on the primary key, delete the given PK.
void	maybeIndex(java.nio.ByteBuffer partitionKey, Clustering clustering, long timestamp, int ttl, OpOrder.Group opGroup, int nowInSec) For indexes on the primary key, index the given PK.
abstract void	update(java.nio.ByteBuffer rowKey, Clustering clustering, Cell oldCell, Cell cell, OpOrder.Group opGroup, int nowInSec) update a column from the index

Methods inherited from class org.apache.cassandra.db.index.SecondaryIndex

baseKeyspace, baseTable, buildIndexAsync, buildIndexBlocking, createInstance, createSecondaryIndexSearcher, estimateResultRows, forceBlockingFlush, getBaseCfs, getColumnDefs, getIndexCfs, getIndexKeyFor, getIndexName, indexes, init, invalidate, isIndexBuilt, newIndexMetadata, reload, removeIndex, setIndexBuilt, setIndexRemoved, supportsOperator, toString, truncateBlocking, validate, validate, validate, validateOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

PerColumnSecondaryIndex

public PerColumnSecondaryIndex()

Method Detail

delete

public abstract void delete(java.nio.ByteBuffer rowKey,
                            Clustering clustering,
                            Cell cell,
                            OpOrder.Group opGroup,
                            int nowInSec)

Called when a column has been tombstoned or replaced.

Parameters:

rowKey - the underlying row key which is indexed

col - all the column info

deleteForCleanup

public abstract void deleteForCleanup(java.nio.ByteBuffer rowKey,
                                      Clustering clustering,
                                      Cell cell,
                                      OpOrder.Group opGroup,
                                      int nowInSec)

Called when a column has been removed due to a cleanup operation.

maybeIndex

public void maybeIndex(java.nio.ByteBuffer partitionKey,
                       Clustering clustering,
                       long timestamp,
                       int ttl,
                       OpOrder.Group opGroup,
                       int nowInSec)

For indexes on the primary key, index the given PK.

maybeDelete

public void maybeDelete(java.nio.ByteBuffer partitionKey,
                        Clustering clustering,
                        DeletionTime deletion,
                        OpOrder.Group opGroup)

For indexes on the primary key, delete the given PK.

insert

public abstract void insert(java.nio.ByteBuffer rowKey,
                            Clustering clustering,
                            Cell cell,
                            OpOrder.Group opGroup)

insert a column to the index

Parameters:

rowKey - the underlying row key which is indexed

col - all the column info

update

public abstract void update(java.nio.ByteBuffer rowKey,
                            Clustering clustering,
                            Cell oldCell,
                            Cell cell,
                            OpOrder.Group opGroup,
                            int nowInSec)

update a column from the index

Parameters:

rowKey - the underlying row key which is indexed

oldCol - the previous column info

col - all the column info

indexPrimaryKeyColumn

protected boolean indexPrimaryKeyColumn()

indexRow

public void indexRow(DecoratedKey key,
                     Row row,
                     OpOrder.Group opGroup,
                     int nowInSec)

getNameForSystemKeyspace

public java.lang.String getNameForSystemKeyspace(java.nio.ByteBuffer column)

Description copied from class: SecondaryIndex

Return the unique name for this index and column to be stored in the SystemKeyspace that tracks if each column is built

Specified by:

getNameForSystemKeyspace in class SecondaryIndex

Parameters:

column - the name of the column

Returns:

the unique name