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

Class SegmentBuilder

java.lang.Object

org.apache.cassandra.index.sai.disk.v1.segment.SegmentBuilder

Direct Known Subclasses:

SegmentBuilder.TrieSegmentBuilder, SegmentBuilder.VectorSegmentBuilder

@NotThreadSafe
public abstract class SegmentBuilder
extends Object

Creates an on-heap index data structure to be flushed to an SSTable index.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SegmentBuilder.TrieSegmentBuilder
static class	SegmentBuilder.VectorSegmentBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final long	LAST_VALID_SEGMENT_ROW_ID

Method Summary

Modifier and Type	Method	Description
long	add(ByteBuffer term, PrimaryKey key, long sstableRowId)
protected abstract long	addInternal(ByteBuffer term, int segmentRowId)
static int	castToSegmentRowId(long sstableRowId, long segmentRowIdOffset)
boolean	exceedsSegmentLimit(long ssTableRowId)
SegmentMetadata	flush(IndexDescriptor indexDescriptor)
protected abstract SegmentMetadata.ComponentMetadataMap	flushInternal(IndexDescriptor indexDescriptor)
static int	getActiveBuilderCount()
long	getMinimumFlushBytes()
int	getRowCount()
boolean	hasReachedMinimumFlushSize()
abstract boolean	isEmpty()
long	release()	This method does three things:
long	totalBytesAllocated()
static void	updateLastValidSegmentRowId(long lastValidSegmentRowID)

Methods inherited from class java.lang.Object

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

Field Details

LAST_VALID_SEGMENT_ROW_ID

public static final long LAST_VALID_SEGMENT_ROW_ID

See Also:

• Constant Field Values

Method Details

getActiveBuilderCount

public static int getActiveBuilderCount()

flush

public SegmentMetadata flush(IndexDescriptor indexDescriptor)
                      throws IOException

Throws:

IOException

add

public long add(ByteBuffer term,
 PrimaryKey key,
 long sstableRowId)

castToSegmentRowId

public static int castToSegmentRowId(long sstableRowId,
 long segmentRowIdOffset)

totalBytesAllocated

public long totalBytesAllocated()

hasReachedMinimumFlushSize

public boolean hasReachedMinimumFlushSize()

getMinimumFlushBytes

public long getMinimumFlushBytes()

release

public long release()

This method does three things:

1. It decrements active builder count and updates the global minimum flush size to reflect that. 2. It releases the builder's memory against its limiter. 3. It defensively marks the builder inactive to make sure nothing bad happens if we try to close it twice.

Returns:

the number of bytes used by the memory limiter after releasing this builder

isEmpty

public abstract boolean isEmpty()

addInternal

protected abstract long addInternal(ByteBuffer term,
 int segmentRowId)

flushInternal

protected abstract SegmentMetadata.ComponentMetadataMap flushInternal(IndexDescriptor indexDescriptor)
                                                               throws IOException

Throws:

IOException

getRowCount

public int getRowCount()

exceedsSegmentLimit

public boolean exceedsSegmentLimit(long ssTableRowId)

Returns:

true if next SSTable row ID exceeds max segment row ID

updateLastValidSegmentRowId

public static void updateLastValidSegmentRowId(long lastValidSegmentRowID)