Package org.apache.pinot.broker.routing.segmentpruner

Class TimeSegmentPruner

java.lang.Object

org.apache.pinot.broker.routing.segmentpruner.TimeSegmentPruner

All Implemented Interfaces:

SegmentZkMetadataFetchListener, SegmentPruner

public class TimeSegmentPruner
extends Object
implements SegmentPruner

The TimeSegmentPruner prunes segments based on their time column start & end time metadata stored in ZK. The pruner supports queries with filter (or nested filter) of EQUALITY and RANGE predicates.

Constructor Summary

Constructors

Constructor	Description
TimeSegmentPruner(org.apache.pinot.spi.config.table.TableConfig tableConfig, String timeColumn, org.apache.pinot.spi.data.DateTimeFormatSpec timeFormatSpec)

Method Summary

Modifier and Type	Method	Description
void	init(org.apache.helix.model.IdealState idealState, org.apache.helix.model.ExternalView externalView, List<String> onlineSegments, List<org.apache.helix.zookeeper.datamodel.ZNRecord> znRecords)	Initializes the segment pruner with the ideal state, external view and online segments (segments with ONLINE/CONSUMING instances in the ideal state and pre-selected by the SegmentPreSelector).
void	onAssignmentChange(org.apache.helix.model.IdealState idealState, org.apache.helix.model.ExternalView externalView, Set<String> onlineSegments, List<String> pulledSegments, List<org.apache.helix.zookeeper.datamodel.ZNRecord> znRecords)	Processes the segment assignment (ideal state or external view) change based on the given online segments (segments with ONLINE/CONSUMING instances in the ideal state and pre-selected by the SegmentPreSelector).
Set<String>	prune(org.apache.pinot.common.request.BrokerRequest brokerRequest, Set<String> segments)	NOTE: Pruning is done by searching _intervalTree based on request time interval and check if the results are in the input segments.
void	refreshSegment(String segment, org.apache.helix.zookeeper.datamodel.ZNRecord znRecord)	Refreshes the metadata for the given segment (called when segment is getting refreshed).

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSegmentPruner

public TimeSegmentPruner(org.apache.pinot.spi.config.table.TableConfig tableConfig,
                         String timeColumn,
                         org.apache.pinot.spi.data.DateTimeFormatSpec timeFormatSpec)

Method Detail

init

public void init(org.apache.helix.model.IdealState idealState,
                 org.apache.helix.model.ExternalView externalView,
                 List<String> onlineSegments,
                 List<org.apache.helix.zookeeper.datamodel.ZNRecord> znRecords)

Description copied from interface: SegmentZkMetadataFetchListener

Initializes the segment pruner with the ideal state, external view and online segments (segments with ONLINE/CONSUMING instances in the ideal state and pre-selected by the SegmentPreSelector). Should be called only once before calling other methods.

Specified by:

init in interface SegmentZkMetadataFetchListener

onAssignmentChange

public void onAssignmentChange(org.apache.helix.model.IdealState idealState,
                               org.apache.helix.model.ExternalView externalView,
                               Set<String> onlineSegments,
                               List<String> pulledSegments,
                               List<org.apache.helix.zookeeper.datamodel.ZNRecord> znRecords)

Description copied from interface: SegmentZkMetadataFetchListener

Processes the segment assignment (ideal state or external view) change based on the given online segments (segments with ONLINE/CONSUMING instances in the ideal state and pre-selected by the SegmentPreSelector).

Specified by:

onAssignmentChange in interface SegmentZkMetadataFetchListener

refreshSegment

public void refreshSegment(String segment,
                           @Nullable
                           org.apache.helix.zookeeper.datamodel.ZNRecord znRecord)

Description copied from interface: SegmentZkMetadataFetchListener

Refreshes the metadata for the given segment (called when segment is getting refreshed).

Specified by:

refreshSegment in interface SegmentZkMetadataFetchListener

prune

public Set<String> prune(org.apache.pinot.common.request.BrokerRequest brokerRequest,
                         Set<String> segments)

NOTE: Pruning is done by searching _intervalTree based on request time interval and check if the results are in the input segments. By doing so we will have run time O(M * logN) (N: # of all online segments, M: # of qualified intersected segments).

Specified by:

prune in interface SegmentPruner