org.apache.cassandra.db.index.composites

Class CompositesIndexOnPartitionKey

java.lang.Object

org.apache.cassandra.db.index.SecondaryIndex

org.apache.cassandra.db.index.PerColumnSecondaryIndex

org.apache.cassandra.db.index.AbstractSimplePerColumnSecondaryIndex

org.apache.cassandra.db.index.composites.CompositesIndex

org.apache.cassandra.db.index.composites.CompositesIndexOnPartitionKey

public class CompositesIndexOnPartitionKey
extends CompositesIndex

Index on a PARTITION_KEY column definition. This suppose a composite row key: rk = rk_0 ... rk_n The corresponding index entry will be: - index row key will be rk_i (where i == columnDef.componentIndex) - cell name will be: rk ck where rk is the fully partition key and ck the clustering keys of the original cell names (thus excluding the last column name as we want to refer to the whole CQL3 row, not just the cell itself) Note that contrarily to other type of index, we repeat the indexed value in the index cell name (we use the whole partition key). The reason is that we want to order the index cell name by partitioner first, and skipping a part of the row key would change the order.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cassandra.db.index.composites.CompositesIndex

CompositesIndex.IndexedEntry

Field Summary

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

columnDef, indexCfs

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

baseCfs, columnDefs, CUSTOM_INDEX_OPTION_NAME, keyComparator, logger

Constructor Summary

Constructors

Constructor and Description
CompositesIndexOnPartitionKey()

Method Summary

Methods

Modifier and Type	Method and Description
static CompositeType	buildIndexComparator(CFMetaData baseMetadata, ColumnDefinition columnDef)
CompositesIndex.IndexedEntry	decodeEntry(DecoratedKey indexedValue, Column indexEntry)
protected java.nio.ByteBuffer	getIndexedValue(java.nio.ByteBuffer rowKey, Column column)
boolean	indexes(java.nio.ByteBuffer name) Returns true if the provided column name is indexed by this secondary index.
boolean	isStale(CompositesIndex.IndexedEntry entry, ColumnFamily data, long now)
protected ColumnNameBuilder	makeIndexColumnNameBuilder(java.nio.ByteBuffer rowKey, java.nio.ByteBuffer columnName)

Methods inherited from class org.apache.cassandra.db.index.composites.CompositesIndex

create, createSecondaryIndexSearcher, delete, getBaseComparator, getExpressionComparator, getIndexComparator, getIndexComparator, makeIndexColumnName, validateOptions

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

delete, expressionString, forceBlockingFlush, getIndexCfs, getIndexName, getLiveSize, init, insert, invalidate, reload, removeIndex, truncateBlocking, update

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

getNameForSystemKeyspace, validate

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

buildIndexAsync, buildIndexBlocking, createInstance, getBaseCfs, getColumnDefs, getIndexKeyFor, isIndexBuilt, setIndexBuilt, setIndexRemoved

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositesIndexOnPartitionKey

public CompositesIndexOnPartitionKey()

Method Detail

buildIndexComparator

public static CompositeType buildIndexComparator(CFMetaData baseMetadata,
                                 ColumnDefinition columnDef)

getIndexedValue

protected java.nio.ByteBuffer getIndexedValue(java.nio.ByteBuffer rowKey,
                                  Column column)

Specified by:

getIndexedValue in class AbstractSimplePerColumnSecondaryIndex

makeIndexColumnNameBuilder

protected ColumnNameBuilder makeIndexColumnNameBuilder(java.nio.ByteBuffer rowKey,
                                           java.nio.ByteBuffer columnName)

Specified by:

makeIndexColumnNameBuilder in class CompositesIndex

decodeEntry

public CompositesIndex.IndexedEntry decodeEntry(DecoratedKey indexedValue,
                                       Column indexEntry)

Specified by:

decodeEntry in class CompositesIndex

indexes

public boolean indexes(java.nio.ByteBuffer name)

Description copied from class: SecondaryIndex

Returns true if the provided column name is indexed by this secondary index. The default implement checks whether the name is one the columnDef name, but this should be overriden but subclass if needed.

Overrides:

indexes in class SecondaryIndex

isStale

public boolean isStale(CompositesIndex.IndexedEntry entry,
              ColumnFamily data,
              long now)

Specified by:

isStale in class CompositesIndex