Package org.apache.cassandra.io.sstable.format.big

Class BigTableReader

java.lang.Object

org.apache.cassandra.io.sstable.SSTable

org.apache.cassandra.io.sstable.format.SSTableReader

org.apache.cassandra.io.sstable.format.SSTableReaderWithFilter

org.apache.cassandra.io.sstable.format.big.BigTableReader

All Implemented Interfaces:

Comparable<SSTableReader>, UnfilteredSource, IndexSummarySupport<BigTableReader>, KeyCacheSupport<BigTableReader>, RefCounted<SSTableReader>, SelfRefCounted<SSTableReader>

public class BigTableReader
extends SSTableReaderWithFilter
implements IndexSummarySupport<BigTableReader>, KeyCacheSupport<BigTableReader>

SSTableReaders are open()ed by Keyspace.onStart; after that they are created by SSTableWriter.renameAndOpen. Do not re-call open() on existing SSTable files; use the references kept by ColumnFamilyStore post-start instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BigTableReader.Builder

Nested classes/interfaces inherited from class org.apache.cassandra.io.sstable.format.SSTableReader

SSTableReader.IndexesBounds, SSTableReader.InstanceTidier, SSTableReader.OpenReason, SSTableReader.Operator, SSTableReader.PartitionPositionBounds, SSTableReader.UniqueIdentifier

Nested classes/interfaces inherited from class org.apache.cassandra.io.sstable.SSTable

SSTable.Owner

Nested classes/interfaces inherited from interface org.apache.cassandra.utils.concurrent.RefCounted

RefCounted.Tidy

Field Summary

Fields inherited from class org.apache.cassandra.io.sstable.format.SSTableReader

bounds, dfile, first, firstKeyComparator, firstKeyOrdering, header, idComparator, idReverseComparator, instanceId, isSuspect, last, lastKeyComparator, maxDataAge, maxTimestampAscending, maxTimestampDescending, openReason, sizeComparator, sstableMetadata, UNIQUE_IDENTIFIER_FACTORY

Fields inherited from class org.apache.cassandra.io.sstable.SSTable

chunkCache, components, compression, descriptor, ioOptions, metadata, TOMBSTONE_HISTOGRAM_BIN_SIZE, TOMBSTONE_HISTOGRAM_SPOOL_SIZE, TOMBSTONE_HISTOGRAM_TTL_ROUND_SECONDS

Constructor Summary

Constructors

Constructor	Description
BigTableReader(BigTableReader.Builder builder, SSTable.Owner owner)

Method Summary

Modifier and Type	Method	Description
SSTableReaderWithFilter	cloneAndReplace(IFilter filter)
SSTableReader	cloneWithNewStart(DecoratedKey newStart)
BigTableReader	cloneWithNewSummarySamplingLevel(ColumnFamilyStore parent, int samplingLevel)	Returns a new SSTableReader with the same properties as this SSTableReader except that a new IndexSummary will be built at the target samplingLevel.
SSTableReader	cloneWithRestoredStart(DecoratedKey restoredStart)
RowIndexEntry	deserializeKeyCacheValue(DataInputPlus input)
long	estimatedKeys()	Calculates an estimate of the number of keys in the sstable represented by this reader.
long	estimatedKeysForRanges(Collection<Range<Token>> ranges)	Calculates an estimate of the number of keys for the given ranges in the sstable represented by this reader.
DecoratedKey	firstKeyBeyond(PartitionPosition token)	Finds and returns the first key beyond a given token in this SSTable or null if no such key exists.
FileHandle	getIndexFile()
IndexSummary	getIndexSummary()
KeyCache	getKeyCache()
Iterable<DecoratedKey>	getKeySamples(Range<Token> range)	Returns sample keys for the provided token range.
ClusteringBound<?>	getLowerBoundPrefixFromCache(DecoratedKey partitionKey, boolean isReversed)	Should quickly get a lower bound prefix from cache only if everything is already availabe in memory and does not need to be loaded from disk.
protected long	getPosition(PartitionPosition key, SSTableReader.Operator op, boolean updateCacheAndStats, SSTableReadsListener listener)	Retrieve a position in data file according to the provided key and operator.
final RowIndexEntry	getRowIndexEntry(PartitionPosition key, SSTableReader.Operator op)	Retrieves the position while updating the key cache and the stats.
RowIndexEntry	getRowIndexEntry(PartitionPosition key, SSTableReader.Operator operator, boolean updateStats, SSTableReadsListener listener)	Retrieve an index entry for the partition found according to the provided key and operator.
IVerifier	getVerifier(ColumnFamilyStore cfs, OutputHandler outputHandler, boolean isOffline, IVerifier.Options options)	Returns a new verifier for this sstable.
boolean	isEstimationInformative()	Returns whether the number of entries in the IndexSummary > 2.
DecoratedKey	keyAtPositionFromSecondaryIndex(long keyPositionFromSecondaryIndex)	Reads the key stored at the position saved in SASI.
KeyReader	keyReader()	Returns a KeyReader over all keys in the sstable.
RandomAccessReader	openIndexReader()
ISSTableScanner	partitionIterator(ColumnFilter columns, DataRange dataRange, SSTableReadsListener listener)	Returns a partition iterator for the given data range.
void	releaseInMemoryComponents()	This method is expected to close the components which occupy memory but are not needed when we just want to stream the components (for example, when SSTable is opened with SSTableLoader).
UnfilteredRowIterator	rowIterator(DecoratedKey key, Slices slices, ColumnFilter selectedColumns, boolean reversed, SSTableReadsListener listener)	Returns a row iterator for the given partition, applying the specified row and column filters.
UnfilteredRowIterator	rowIterator(FileDataInput file, DecoratedKey key, RowIndexEntry indexEntry, Slices slices, ColumnFilter selectedColumns, boolean reversed)
protected List<AutoCloseable>	setupInstance(boolean trackHotness)
protected final BigTableReader.Builder	unbuildTo(BigTableReader.Builder builder, boolean sharedCopy)

Methods inherited from class org.apache.cassandra.io.sstable.format.SSTableReaderWithFilter

getFilterOffHeapSize, getFilterSerializedSize, getFilterTracker, isPresentInFilter, mayContainAssumingKeyIsInRange, notifySelected, notifySkipped, unbuildTo

Methods inherited from class org.apache.cassandra.io.sstable.format.SSTableReader

addTo, bytesOnDisk, closeInternalComponent, compareTo, createLinks, createLinks, createLinks, createLinks, equals, getApproximateKeyCount, getAvgColumnSetPerRow, getBounds, getCompressionMetadata, getCompressionMetadataOffHeapSize, getCompressionRatio, getCrcCheckChance, getDataChannel, getDataCreationTime, getDroppableTombstonesBefore, getEstimatedCellPerPartitionCount, getEstimatedDroppableTombstoneRatio, getEstimatedPartitionSize, getFileDataInput, getFilename, getFirst, getInterval, getLast, getMaxLocalDeletionTime, getMaxTimestamp, getMaxTTL, getMinLocalDeletionTime, getMinTimestamp, getMinTTL, getPendingRepair, getPosition, getPosition, getPosition, getPositionsForBounds, getPositionsForBoundsIterator, getPositionsForFullRange, getPositionsForRanges, getReadMeter, getRepairedAt, getScanner, getScanner, getScanner, getScanner, getSSTableLevel, getSSTableMetadata, getTotalBytes, getTotalColumnsSet, getTotalRows, getTotalUncompressedBytes, hashCode, incrementReadCount, instanceId, intersects, isMarkedCompacted, isMarkedSuspect, isPendingRepair, isRepaired, isReplaced, isTransient, keyIterator, logicalBytesOnDisk, markObsolete, markSuspect, maybeGetChecksumValidator, maybeGetDigestValidator, maybePersistSSTableReadMeter, mayHaveTombstones, moveAndOpenSSTable, mutateLevelAndReload, mutateRepairedAndReload, newSince, onDiskLength, onDiskSizeForPartitionPositions, open, open, open, open, openAll, openDataReader, openDataReader, openDataReaderForScan, openForBatch, openNoValidation, openNoValidation, overrideReadMeter, ref, reloadSSTableMetadata, resetTidying, runOnClose, runWithLock, selfRef, setCrcCheckChance, setReplaced, setup, setupOnline, shutdownBlocking, simpleIterator, stats, tokenSpaceCoverage, tryRef, trySkipFileCacheBefore, unbuildTo, uncompressedLength, unmarkSuspect, validate

Methods inherited from class org.apache.cassandra.io.sstable.SSTable

addComponents, copy, decorateKey, getAllFilePaths, getColumnFamilyName, getComponents, getId, getKeyspaceName, getPartitioner, getStreamingComponents, hardlink, metadata, owner, registerComponents, rename, toString, tryComponentFromFilename, tryComponentFromFilename, tryDescriptorFromFile, unbuildTo, unregisterComponents, validateRepairedMetadata

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.cassandra.io.sstable.keycache.KeyCacheSupport

cacheKey, getCachedPosition, getCachedPosition, getCacheKey, getCacheKey

Methods inherited from interface org.apache.cassandra.db.rows.UnfilteredSource

rowIterator

Constructor Details

BigTableReader

public BigTableReader(BigTableReader.Builder builder,
 SSTable.Owner owner)

Method Details

setupInstance

protected List<AutoCloseable> setupInstance(boolean trackHotness)

Overrides:

setupInstance in class SSTableReaderWithFilter

releaseInMemoryComponents

public void releaseInMemoryComponents()

Description copied from class: SSTableReader

This method is expected to close the components which occupy memory but are not needed when we just want to stream the components (for example, when SSTable is opened with SSTableLoader). The method should call SSTableReader.closeInternalComponent(AutoCloseable) for each such component. Leaving the implementation empty is valid given there are not such resources to release.

Specified by:

releaseInMemoryComponents in class SSTableReader

getIndexSummary

public IndexSummary getIndexSummary()

Specified by:

getIndexSummary in interface IndexSummarySupport<BigTableReader>

rowIterator

public UnfilteredRowIterator rowIterator(DecoratedKey key,
 Slices slices,
 ColumnFilter selectedColumns,
 boolean reversed,
 SSTableReadsListener listener)

Description copied from interface: UnfilteredSource

Returns a row iterator for the given partition, applying the specified row and column filters.

Specified by:

rowIterator in interface UnfilteredSource

Parameters:

key - the partition key

slices - the row ranges to return

selectedColumns - filter to apply to all returned partitions

reversed - true if the content should be returned in reverse order

listener - a listener used to handle internal read events

rowIterator

public UnfilteredRowIterator rowIterator(FileDataInput file,
 DecoratedKey key,
 RowIndexEntry indexEntry,
 Slices slices,
 ColumnFilter selectedColumns,
 boolean reversed)

partitionIterator

public ISSTableScanner partitionIterator(ColumnFilter columns,
 DataRange dataRange,
 SSTableReadsListener listener)

Description copied from interface: UnfilteredSource

Returns a partition iterator for the given data range.

Specified by:

partitionIterator in interface UnfilteredSource

Parameters:

columns - filter to apply to all returned partitions

dataRange - the partition and clustering range queried

listener - a listener used to handle internal read events

keyReader

public KeyReader keyReader()
                    throws IOException

Description copied from class: SSTableReader

Returns a KeyReader over all keys in the sstable.

Specified by:

keyReader in class SSTableReader

Throws:

IOException

firstKeyBeyond

public DecoratedKey firstKeyBeyond(PartitionPosition token)

Finds and returns the first key beyond a given token in this SSTable or null if no such key exists.

Specified by:

firstKeyBeyond in class SSTableReader

getRowIndexEntry

public final RowIndexEntry getRowIndexEntry(PartitionPosition key,
 SSTableReader.Operator op)

Retrieves the position while updating the key cache and the stats.

Parameters:

key - The key to apply as the rhs to the given Operator. A 'fake' key is allowed to allow key selection by token bounds but only if op != * EQ

op - The Operator defining matching keys: the nearest key to the target matching the operator wins.

getRowIndexEntry

public RowIndexEntry getRowIndexEntry(PartitionPosition key,
 SSTableReader.Operator operator,
 boolean updateStats,
 SSTableReadsListener listener)

Description copied from class: SSTableReader

Retrieve an index entry for the partition found according to the provided key and operator.

Specified by:

getRowIndexEntry in class SSTableReader

Parameters:

key - The key to apply as the rhs to the given Operator. A 'fake' key is allowed to allow key selection by token bounds but only if op != * EQ

operator - The Operator defining matching keys: the nearest key to the target matching the operator wins.

updateStats - true if updating stats and cache

listener - a listener used to handle internal events

Returns:

The index entry corresponding to the key, or null if the key is not present

getPosition

protected long getPosition(PartitionPosition key,
 SSTableReader.Operator op,
 boolean updateCacheAndStats,
 SSTableReadsListener listener)

Description copied from class: SSTableReader

Retrieve a position in data file according to the provided key and operator.

Overrides:

getPosition in class SSTableReader

Parameters:

key - The key to apply as the rhs to the given Operator. A 'fake' key is allowed to allow key selection by token bounds but only if op != * EQ

op - The Operator defining matching keys: the nearest key to the target matching the operator wins.

updateCacheAndStats - true if updating stats and cache

listener - a listener used to handle internal events

Returns:

The index entry corresponding to the key, or null if the key is not present

keyAtPositionFromSecondaryIndex

public DecoratedKey keyAtPositionFromSecondaryIndex(long keyPositionFromSecondaryIndex)
                                             throws IOException

Description copied from class: SSTableReader

Reads the key stored at the position saved in SASI.

When SASI is created, it uses key locations retrieved from KeyReader.keyPositionForSecondaryIndex(). This method is to read the key stored at such position. It is up to the concrete SSTable format implementation what that position means and which file it refers. The only requirement is that it is consistent with what KeyReader.keyPositionForSecondaryIndex() returns.

Specified by:

keyAtPositionFromSecondaryIndex in class SSTableReader

Returns:

key if found, null otherwise

Throws:

IOException

deserializeKeyCacheValue

public RowIndexEntry deserializeKeyCacheValue(DataInputPlus input)
                                       throws IOException

Specified by:

deserializeKeyCacheValue in interface KeyCacheSupport<BigTableReader>

Throws:

IOException

getLowerBoundPrefixFromCache

public ClusteringBound<?> getLowerBoundPrefixFromCache(DecoratedKey partitionKey,
 boolean isReversed)

Description copied from interface: KeyCacheSupport

Should quickly get a lower bound prefix from cache only if everything is already availabe in memory and does not need to be loaded from disk.

Specified by:

getLowerBoundPrefixFromCache in interface KeyCacheSupport<BigTableReader>

estimatedKeys

public long estimatedKeys()

Description copied from class: SSTableReader

Calculates an estimate of the number of keys in the sstable represented by this reader.

Specified by:

estimatedKeys in class SSTableReader

Returns:

An estimate of the number of keys in this SSTable based on the index summary.

estimatedKeysForRanges

public long estimatedKeysForRanges(Collection<Range<Token>> ranges)

Description copied from class: SSTableReader

Calculates an estimate of the number of keys for the given ranges in the sstable represented by this reader.

Specified by:

estimatedKeysForRanges in class SSTableReader

Returns:

An estimate of the number of keys for given ranges in this SSTable.

isEstimationInformative

public boolean isEstimationInformative()

Returns whether the number of entries in the IndexSummary > 2. At full sampling, this is approximately 1/INDEX_INTERVALth of the keys in this SSTable.

Specified by:

isEstimationInformative in class SSTableReader

getKeySamples

public Iterable<DecoratedKey> getKeySamples(Range<Token> range)

Description copied from class: SSTableReader

Returns sample keys for the provided token range.

Specified by:

getKeySamples in class SSTableReader

openIndexReader

public RandomAccessReader openIndexReader()

getIndexFile

public FileHandle getIndexFile()

getVerifier

public IVerifier getVerifier(ColumnFamilyStore cfs,
 OutputHandler outputHandler,
 boolean isOffline,
 IVerifier.Options options)

Description copied from class: SSTableReader

Returns a new verifier for this sstable. Note that the reader must match the provided cfs.

Specified by:

getVerifier in class SSTableReader

unbuildTo

protected final BigTableReader.Builder unbuildTo(BigTableReader.Builder builder,
 boolean sharedCopy)

cloneAndReplace

public SSTableReaderWithFilter cloneAndReplace(IFilter filter)

Specified by:

cloneAndReplace in class SSTableReaderWithFilter

cloneWithRestoredStart

public SSTableReader cloneWithRestoredStart(DecoratedKey restoredStart)

Specified by:

cloneWithRestoredStart in class SSTableReader

cloneWithNewStart

public SSTableReader cloneWithNewStart(DecoratedKey newStart)

Specified by:

cloneWithNewStart in class SSTableReader

cloneWithNewSummarySamplingLevel

public BigTableReader cloneWithNewSummarySamplingLevel(ColumnFamilyStore parent,
 int samplingLevel)
                                                throws IOException

Returns a new SSTableReader with the same properties as this SSTableReader except that a new IndexSummary will be built at the target samplingLevel. This (original) SSTableReader instance will be marked as replaced, have its DeletingTask removed, and have its periodic read-meter sync task cancelled.

Specified by:

cloneWithNewSummarySamplingLevel in interface IndexSummarySupport<BigTableReader>

Parameters:

samplingLevel - the desired sampling level for the index summary on the new SSTableReader

Returns:

a new SSTableReader

Throws:

IOException

getKeyCache

public KeyCache getKeyCache()

Specified by:

getKeyCache in interface KeyCacheSupport<BigTableReader>