Package org.apache.pinot.segment.spi.store

Class SegmentDirectory.Writer

java.lang.Object

org.apache.pinot.segment.spi.store.SegmentDirectory.Reader

org.apache.pinot.segment.spi.store.SegmentDirectory.Writer

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

SegmentDirectory

public abstract class SegmentDirectory.Writer
extends SegmentDirectory.Reader

Writer to update columnar index. Read about the semantics at the top

Constructor Summary

Constructors

Constructor	Description
Writer()

Method Summary

Modifier and Type	Method	Description
abstract PinotDataBuffer	newIndexFor(String columnName, ColumnIndexType indexType, long sizeBytes)	create a new buffer for writers to store index.
abstract void	removeIndex(String columnName, ColumnIndexType indexType)	Removes an existing column index from directory
abstract void	save()
abstract String	toString()

Methods inherited from class org.apache.pinot.segment.spi.store.SegmentDirectory.Reader

getIndexFor, getStarTreeIndex, getStarTreeIndexMap, hasIndexFor, toSegmentDirectory

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

Writer

public Writer()

Method Detail

newIndexFor

public abstract PinotDataBuffer newIndexFor(String columnName,
                                            ColumnIndexType indexType,
                                            long sizeBytes)
                                     throws IOException

create a new buffer for writers to store index. This buffer will be visible after this point. Failures in the middle can cause corruption.

Parameters:

columnName - column name

indexType - column index type

sizeBytes - sizeBytes of index data

Returns:

PinotDataBufferOld that writers can update

Throws:

IOException

removeIndex

public abstract void removeIndex(String columnName,
                                 ColumnIndexType indexType)

Removes an existing column index from directory

Parameters:

columnName - column name

indexType - column index type

save

public abstract void save()
                   throws IOException

Throws:

IOException

toString

public abstract String toString()

Specified by:

toString in class SegmentDirectory.Reader