Package org.apache.cassandra.index.sai.disk

Class StorageAttachedIndexWriter

java.lang.Object

org.apache.cassandra.index.sai.disk.StorageAttachedIndexWriter

All Implemented Interfaces:

SSTableFlushObserver

@NotThreadSafe
public class StorageAttachedIndexWriter
extends Object
implements SSTableFlushObserver

Writes all on-disk index structures attached to a given SSTable.

Method Summary

Modifier and Type	Method	Description
void	abort(Throwable accumulator)	Aborts all column index writers and, only if they have not yet completed, SSTable-level component writers.
void	abort(Throwable accumulator, boolean fromIndex)
void	begin()	Called before writing any data to the sstable.
void	complete()	Called when all data is written to the file and it's ready to be finished up.
static StorageAttachedIndexWriter	createBuilderWriter(IndexDescriptor indexDescriptor, Collection<StorageAttachedIndex> indexes, LifecycleNewTracker lifecycleNewTracker, boolean perIndexComponentsOnly)
static StorageAttachedIndexWriter	createFlushObserverWriter(IndexDescriptor indexDescriptor, Collection<StorageAttachedIndex> indexes, LifecycleNewTracker lifecycleNewTracker)
void	nextUnfilteredCluster(Unfiltered unfiltered)	Called after an unfiltered is written to the sstable.
void	onSSTableWriterSwitched()	Called when current sstable writer is switched during sharded compaction to free any in-memory resources associated with the sstable without waiting for full transaction to complete
void	startPartition(DecoratedKey key, long keyPosition, long keyPositionForSASI)	Called when a new partition in being written to the sstable, but before any cells are processed (see SSTableFlushObserver.nextUnfilteredCluster(Unfiltered)).
void	staticRow(Row staticRow)	Called when a static row is being written to the sstable.

Methods inherited from class java.lang.Object

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

Method Details

createFlushObserverWriter

public static StorageAttachedIndexWriter createFlushObserverWriter(IndexDescriptor indexDescriptor,
 Collection<StorageAttachedIndex> indexes,
 LifecycleNewTracker lifecycleNewTracker)
                                                            throws IOException

Throws:

IOException

createBuilderWriter

public static StorageAttachedIndexWriter createBuilderWriter(IndexDescriptor indexDescriptor,
 Collection<StorageAttachedIndex> indexes,
 LifecycleNewTracker lifecycleNewTracker,
 boolean perIndexComponentsOnly)
                                                      throws IOException

Throws:

IOException

begin

public void begin()

Description copied from interface: SSTableFlushObserver

Called before writing any data to the sstable.

Specified by:

begin in interface SSTableFlushObserver

startPartition

public void startPartition(DecoratedKey key,
 long keyPosition,
 long keyPositionForSASI)

Description copied from interface: SSTableFlushObserver

Called when a new partition in being written to the sstable, but before any cells are processed (see SSTableFlushObserver.nextUnfilteredCluster(Unfiltered)).

Specified by:

startPartition in interface SSTableFlushObserver

Parameters:

key - the key being appended to SSTable.

keyPosition - the position of the key in the SSTable data file

keyPositionForSASI - SSTable format specific key position for storage attached indexes, it can be in data file or in some index file. It is the same position as returned by KeyReader.keyPositionForSecondaryIndex() for the same format, and the same position as expected by SSTableReader.keyAtPositionFromSecondaryIndex(long).

nextUnfilteredCluster

public void nextUnfilteredCluster(Unfiltered unfiltered)

Description copied from interface: SSTableFlushObserver

Called after an unfiltered is written to the sstable. Will be preceded by a call to SSTableFlushObserver.startPartition(DecoratedKey, long, long), and the unfiltered should be assumed to belong to that partition.

Specified by:

nextUnfilteredCluster in interface SSTableFlushObserver

Parameters:

unfiltered - the unfiltered being written to the SSTable

staticRow

public void staticRow(Row staticRow)

Description copied from interface: SSTableFlushObserver

Called when a static row is being written to the sstable. If static columns are present in the table, it is called after SSTableFlushObserver.startPartition(DecoratedKey, long, long) and before any calls to SSTableFlushObserver.nextUnfilteredCluster(Unfiltered).

Specified by:

staticRow in interface SSTableFlushObserver

Parameters:

staticRow - static row appended to the sstable, can be empty, may not be null

onSSTableWriterSwitched

public void onSSTableWriterSwitched()

Description copied from interface: SSTableFlushObserver

Called when current sstable writer is switched during sharded compaction to free any in-memory resources associated with the sstable without waiting for full transaction to complete

Specified by:

onSSTableWriterSwitched in interface SSTableFlushObserver

complete

public void complete()

Description copied from interface: SSTableFlushObserver

Called when all data is written to the file and it's ready to be finished up.

Specified by:

complete in interface SSTableFlushObserver

abort

public void abort(Throwable accumulator)

Aborts all column index writers and, only if they have not yet completed, SSTable-level component writers.

Specified by:

abort in interface SSTableFlushObserver

Parameters:

accumulator - the initial exception thrown from the failed writer

abort

public void abort(Throwable accumulator,
 boolean fromIndex)

Parameters:

accumulator - original cause of the abort

fromIndex - true if the cause of the abort was the index itself, false otherwise