org.apache.flink.table.runtime.operators.rank

Class UpdatableTopNFunction

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.KeyedProcessFunction<K,IN,OUT>

org.apache.flink.table.runtime.functions.KeyedProcessFunctionWithCleanupState<BaseRow,BaseRow,BaseRow>

org.apache.flink.table.runtime.operators.rank.AbstractTopNFunction

org.apache.flink.table.runtime.operators.rank.UpdatableTopNFunction

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.streaming.api.checkpoint.CheckpointedFunction, CleanupState

public class UpdatableTopNFunction
extends AbstractTopNFunction
implements org.apache.flink.streaming.api.checkpoint.CheckpointedFunction

The function could handle update input stream. It is a fast version of RetractableTopNFunction which only hold top n data in state, and keep sorted map in heap. However, the function only works in some special scenarios: 1. sort field collation is ascending and its mono is decreasing, or sort field collation is descending and its mono is increasing 2. input data has unique keys 3. input stream could not contain delete record or retract record

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.streaming.api.functions.KeyedProcessFunction

org.apache.flink.streaming.api.functions.KeyedProcessFunction.Context, org.apache.flink.streaming.api.functions.KeyedProcessFunction.OnTimerContext

Field Summary

Fields inherited from class org.apache.flink.table.runtime.operators.rank.AbstractTopNFunction

hitCount, inputRowType, keyContext, outputRankNumber, rankEnd, requestCount, sortKeyComparator, sortKeySelector

Fields inherited from class org.apache.flink.table.runtime.functions.KeyedProcessFunctionWithCleanupState

stateCleaningEnabled

Constructor Summary

Constructors

Constructor and Description
UpdatableTopNFunction(long minRetentionTime, long maxRetentionTime, BaseRowTypeInfo inputRowType, BaseRowKeySelector rowKeySelector, GeneratedRecordComparator generatedRecordComparator, BaseRowKeySelector sortKeySelector, RankType rankType, RankRange rankRange, boolean generateRetraction, boolean outputRankNumber, long cacheSize)

Method Summary

Modifier and Type	Method and Description
void	initializeState(org.apache.flink.runtime.state.FunctionInitializationContext context)
void	onTimer(long timestamp, org.apache.flink.streaming.api.functions.KeyedProcessFunction.OnTimerContext ctx, org.apache.flink.util.Collector<BaseRow> out)
void	open(org.apache.flink.configuration.Configuration parameters)
void	processElement(BaseRow input, org.apache.flink.streaming.api.functions.KeyedProcessFunction.Context context, org.apache.flink.util.Collector<BaseRow> out)
void	snapshotState(org.apache.flink.runtime.state.FunctionSnapshotContext context)

Methods inherited from class org.apache.flink.table.runtime.operators.rank.AbstractTopNFunction

checkSortKeyInBufferRange, collect, collect, delete, delete, getDefaultTopNSize, hasOffset, initRankEnd, isInRankEnd, isInRankRange, registerMetric, retract, setKeyContext

Methods inherited from class org.apache.flink.table.runtime.functions.KeyedProcessFunctionWithCleanupState

cleanupState, initCleanupTimeState, isProcessingTimeTimer, needToCleanupState, registerProcessingCleanupTimer

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.runtime.functions.CleanupState

registerProcessingCleanupTimer

Constructor Detail

UpdatableTopNFunction

public UpdatableTopNFunction(long minRetentionTime,
                             long maxRetentionTime,
                             BaseRowTypeInfo inputRowType,
                             BaseRowKeySelector rowKeySelector,
                             GeneratedRecordComparator generatedRecordComparator,
                             BaseRowKeySelector sortKeySelector,
                             RankType rankType,
                             RankRange rankRange,
                             boolean generateRetraction,
                             boolean outputRankNumber,
                             long cacheSize)

Method Detail

open

public void open(org.apache.flink.configuration.Configuration parameters)
          throws Exception

Specified by:

open in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

open in class AbstractTopNFunction

Throws:

Exception

onTimer

public void onTimer(long timestamp,
                    org.apache.flink.streaming.api.functions.KeyedProcessFunction.OnTimerContext ctx,
                    org.apache.flink.util.Collector<BaseRow> out)
             throws Exception

Overrides:

onTimer in class org.apache.flink.streaming.api.functions.KeyedProcessFunction<BaseRow,BaseRow,BaseRow>

Throws:

Exception

initializeState

public void initializeState(org.apache.flink.runtime.state.FunctionInitializationContext context)
                     throws Exception

Specified by:

initializeState in interface org.apache.flink.streaming.api.checkpoint.CheckpointedFunction

Throws:

Exception

processElement

public void processElement(BaseRow input,
                           org.apache.flink.streaming.api.functions.KeyedProcessFunction.Context context,
                           org.apache.flink.util.Collector<BaseRow> out)
                    throws Exception

Specified by:

processElement in class org.apache.flink.streaming.api.functions.KeyedProcessFunction<BaseRow,BaseRow,BaseRow>

Throws:

Exception

snapshotState

public void snapshotState(org.apache.flink.runtime.state.FunctionSnapshotContext context)
                   throws Exception

Specified by:

snapshotState in interface org.apache.flink.streaming.api.checkpoint.CheckpointedFunction

Throws:

Exception