Package org.apache.cassandra.index.sai.memory

Class TrieMemoryIndex

java.lang.Object

org.apache.cassandra.index.sai.memory.MemoryIndex

org.apache.cassandra.index.sai.memory.TrieMemoryIndex

All Implemented Interfaces:

MemtableOrdering

public class TrieMemoryIndex
extends MemoryIndex

This is an in-memory index using the InMemoryTrie to store a ByteComparable representation of the indexed values. Data is stored on-heap or off-heap and follows the settings of the TrieMemtable to determine where.

Field Summary

Fields inherited from class org.apache.cassandra.index.sai.memory.MemoryIndex

index

Constructor Summary

Constructors

Constructor	Description
TrieMemoryIndex(StorageAttachedIndex index)

Method Summary

Modifier and Type	Method	Description
long	add(DecoratedKey key, Clustering<?> clustering, ByteBuffer value)	Adds an index value to the in-memory index
ByteBuffer	getMaxTerm()
ByteBuffer	getMinTerm()
boolean	isEmpty()
Iterator<Pair<ByteComparable,PrimaryKeys>>	iterator()	Returns an Iterator over the entire dataset contained in the trie.
CloseableIterator<PrimaryKeyWithScore>	orderBy(QueryContext queryContext, Expression orderer, AbstractBounds<PartitionPosition> keyRange)	Order the index based on the given orderer (expression).
CloseableIterator<PrimaryKeyWithScore>	orderResultsBy(QueryContext context, List<PrimaryKey> results, Expression orderer)	Order the given list of PrimaryKey results corresponding to the given orderer.
KeyRangeIterator	search(QueryContext queryContext, Expression expression, AbstractBounds<PartitionPosition> keyRange)	Search for an expression in the in-memory index within the AbstractBounds defined by keyRange.
long	update(DecoratedKey key, Clustering<?> clustering, ByteBuffer oldValue, ByteBuffer newValue)
SegmentMetadata.ComponentMetadataMap	writeDirect(IndexDescriptor indexDescriptor, IndexIdentifier indexIdentifier, Function<PrimaryKey,Integer> postingTransformer)

Methods inherited from class java.lang.Object

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

Constructor Details

TrieMemoryIndex

public TrieMemoryIndex(StorageAttachedIndex index)

Method Details

add

public long add(DecoratedKey key,
 Clustering<?> clustering,
 ByteBuffer value)

Adds an index value to the in-memory index

Specified by:

add in class MemoryIndex

Parameters:

key - partition key for the indexed value

clustering - clustering for the indexed value

value - indexed value

Returns:

amount of heap allocated by the new value

update

public long update(DecoratedKey key,
 Clustering<?> clustering,
 ByteBuffer oldValue,
 ByteBuffer newValue)

Specified by:

update in class MemoryIndex

search

public KeyRangeIterator search(QueryContext queryContext,
 Expression expression,
 AbstractBounds<PartitionPosition> keyRange)

Search for an expression in the in-memory index within the AbstractBounds defined by keyRange. This can either be an exact match or a range match.

Specified by:

search in class MemoryIndex

Parameters:

expression - the Expression to search for

keyRange - the AbstractBounds containing the key range to restrict the search to

Returns:

a KeyRangeIterator containing the search results

iterator

public Iterator<Pair<ByteComparable,PrimaryKeys>> iterator()

Returns an Iterator over the entire dataset contained in the trie. This is used when the index is flushed to disk.

Specified by:

iterator in class MemoryIndex

Returns:

the iterator containing the trie data

writeDirect

public SegmentMetadata.ComponentMetadataMap writeDirect(IndexDescriptor indexDescriptor,
 IndexIdentifier indexIdentifier,
 Function<PrimaryKey,Integer> postingTransformer)

Specified by:

writeDirect in class MemoryIndex

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in class MemoryIndex

getMinTerm

public ByteBuffer getMinTerm()

Specified by:

getMinTerm in class MemoryIndex

getMaxTerm

public ByteBuffer getMaxTerm()

Specified by:

getMaxTerm in class MemoryIndex

orderBy

public CloseableIterator<PrimaryKeyWithScore> orderBy(QueryContext queryContext,
 Expression orderer,
 AbstractBounds<PartitionPosition> keyRange)

Description copied from interface: MemtableOrdering

Order the index based on the given orderer (expression).

Parameters:

queryContext - - the query context

orderer - - the expression to order by

keyRange - - the key range to search

Returns:

an iterator over the results in score order.

orderResultsBy

public CloseableIterator<PrimaryKeyWithScore> orderResultsBy(QueryContext context,
 List<PrimaryKey> results,
 Expression orderer)

Description copied from interface: MemtableOrdering

Order the given list of PrimaryKey results corresponding to the given orderer. Returns an iterator over the results in score order. Assumes that the given spans the same rows as the implementing index's segment.