Package org.apache.flink.table.runtime.operators.aggregate.asyncwindow.processors

Class AbstractAsyncStateSliceWindowAggProcessor

java.lang.Object

org.apache.flink.table.runtime.operators.aggregate.window.processors.WindowAggProcessorBase<W,AsyncStateWindowProcessor.AsyncStateContext<W>>

org.apache.flink.table.runtime.operators.aggregate.asyncwindow.processors.AbstractAsyncStateWindowAggProcessor<Long>

org.apache.flink.table.runtime.operators.aggregate.asyncwindow.processors.AbstractAsyncStateSliceWindowAggProcessor

All Implemented Interfaces:

Serializable, AsyncStateWindowProcessor<Long>, AsyncStateSlicingWindowProcessor<Long>, WindowProcessor<Long,AsyncStateWindowProcessor.AsyncStateContext<Long>>

Direct Known Subclasses:

AsyncStateSliceSharedWindowAggProcessor, AsyncStateSliceUnsharedWindowAggProcessor

public abstract class AbstractAsyncStateSliceWindowAggProcessor
extends AbstractAsyncStateWindowAggProcessor<Long>
implements AsyncStateSlicingWindowProcessor<Long>

A base implementation of AsyncStateSlicingWindowProcessor for window aggregate.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.table.runtime.operators.aggregate.asyncwindow.processors.AbstractAsyncStateWindowAggProcessor

AbstractAsyncStateWindowAggProcessor.WindowIsEmptyChecker

Nested classes/interfaces inherited from interface org.apache.flink.table.runtime.operators.window.async.tvf.common.AsyncStateWindowProcessor

AsyncStateWindowProcessor.AsyncStateContext<W>

Nested classes/interfaces inherited from interface org.apache.flink.table.runtime.operators.window.tvf.common.WindowProcessor

WindowProcessor.Context<W>

Field Summary

Fields

Modifier and Type	Field	Description
protected final SliceAssigner	sliceAssigner
protected AsyncStateWindowBuffer	windowBuffer
protected final AsyncStateWindowBuffer.Factory	windowBufferFactory
protected final long	windowInterval

Fields inherited from class org.apache.flink.table.runtime.operators.aggregate.asyncwindow.processors.AbstractAsyncStateWindowAggProcessor

emptyChecker, windowState

Fields inherited from class org.apache.flink.table.runtime.operators.aggregate.window.processors.WindowAggProcessorBase

accSerializer, aggregator, clockService, ctx, currentProgress, genAggsHandler, isEventTime, reuseOutput, shiftTimeZone, useDayLightSaving, windowTimerService

Constructor Summary

Constructors

Constructor	Description
AbstractAsyncStateSliceWindowAggProcessor(GeneratedNamespaceAggsHandleFunction<Long> genAggsHandler, AsyncStateWindowBuffer.Factory bufferFactory, SliceAssigner sliceAssigner, org.apache.flink.api.common.typeutils.TypeSerializer<org.apache.flink.table.data.RowData> accSerializer, int indexOfCountStar, ZoneId shiftTimeZone)

Method Summary

Modifier and Type	Method	Description
org.apache.flink.api.common.state.v2.StateFuture<Void>	advanceProgress(org.apache.flink.table.data.RowData currentKey, long progress)	Advances the progress time, the progress time is watermark if working in event-time mode, or current processing time if working in processing-time mode.
org.apache.flink.api.common.state.v2.StateFuture<Void>	clearWindow(long timerTimestamp, Long windowEnd)	Clear state and resources associated with the given window namespace.
void	close()	The tear-down method of the function.
org.apache.flink.api.common.typeutils.TypeSerializer<Long>	createWindowSerializer()	Returns the serializer of the window type.
protected WindowTimerService<Long>	getWindowTimerService()
void	open(AsyncStateWindowProcessor.AsyncStateContext<Long> context)	Initialization method for the function.
org.apache.flink.api.common.state.v2.StateFuture<Void>	prepareCheckpoint()	Performs a preparation before checkpoint.
org.apache.flink.api.common.state.v2.StateFuture<Boolean>	processElement(org.apache.flink.table.data.RowData key, org.apache.flink.table.data.RowData element)	Process an element with associated key from the input stream.
protected abstract org.apache.flink.api.common.state.v2.StateFuture<Long>	sliceStateMergeTarget(long sliceToMerge)	Returns the slice state target to merge the given slice into when firing windows.

Methods inherited from class org.apache.flink.table.runtime.operators.aggregate.asyncwindow.processors.AbstractAsyncStateWindowAggProcessor

prepareAggregator

Methods inherited from class org.apache.flink.table.runtime.operators.aggregate.window.processors.WindowAggProcessorBase

collect, initializeWatermark

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.operators.window.async.tvf.common.AsyncStateWindowProcessor

fireWindow

Methods inherited from interface org.apache.flink.table.runtime.operators.window.tvf.common.WindowProcessor

initializeWatermark

Field Details

windowBufferFactory

protected final AsyncStateWindowBuffer.Factory windowBufferFactory

sliceAssigner

protected final SliceAssigner sliceAssigner

windowInterval

protected final long windowInterval

windowBuffer

protected transient AsyncStateWindowBuffer windowBuffer

Constructor Details

AbstractAsyncStateSliceWindowAggProcessor

public AbstractAsyncStateSliceWindowAggProcessor(GeneratedNamespaceAggsHandleFunction<Long> genAggsHandler,
 AsyncStateWindowBuffer.Factory bufferFactory,
 SliceAssigner sliceAssigner,
 org.apache.flink.api.common.typeutils.TypeSerializer<org.apache.flink.table.data.RowData> accSerializer,
 int indexOfCountStar,
 ZoneId shiftTimeZone)

Method Details

open

public void open(AsyncStateWindowProcessor.AsyncStateContext<Long> context)
          throws Exception

Description copied from interface: WindowProcessor

Initialization method for the function. It is called before the actual working methods.

Specified by:

open in interface WindowProcessor<Long,AsyncStateWindowProcessor.AsyncStateContext<Long>>

Overrides:

open in class AbstractAsyncStateWindowAggProcessor<Long>

Throws:

Exception

getWindowTimerService

protected WindowTimerService<Long> getWindowTimerService()

Specified by:

getWindowTimerService in class WindowAggProcessorBase<Long,AsyncStateWindowProcessor.AsyncStateContext<Long>>

processElement

public org.apache.flink.api.common.state.v2.StateFuture<Boolean> processElement(org.apache.flink.table.data.RowData key,
 org.apache.flink.table.data.RowData element)
                                                                         throws Exception

Description copied from interface: AsyncStateWindowProcessor

Process an element with associated key from the input stream. Returns true if this element is dropped because of late arrival.

Specified by:

processElement in interface AsyncStateWindowProcessor<Long>

Parameters:

key - the key associated with the element

element - The element to process.

Throws:

Exception

sliceStateMergeTarget

protected abstract org.apache.flink.api.common.state.v2.StateFuture<Long> sliceStateMergeTarget(long sliceToMerge)
                                                                                         throws Exception

Returns the slice state target to merge the given slice into when firing windows. For unshared windows, there should no merging happens, so the merge target should be just the given sliceToMerge. For shared windows, the merge target should be the shared slice state.

Throws:

Exception

See Also:

• SliceSharedAssigner.mergeSlices(long, MergeCallback)

advanceProgress

public org.apache.flink.api.common.state.v2.StateFuture<Void> advanceProgress(org.apache.flink.table.data.RowData currentKey,
 long progress)
                                                                       throws Exception

Description copied from interface: AsyncStateWindowProcessor

Advances the progress time, the progress time is watermark if working in event-time mode, or current processing time if working in processing-time mode.

This will potentially flush buffered data into states, because the watermark advancement may be in a very small step, but we don't need to flush buffered data for every watermark advancement.

Note: There may be multiple different keys within the buffer. When flushing them to the async state, only the async state request for the current key of the operator will be returned as a StateFuture. Requests for async states for other keys will not be waited on.

Specified by:

advanceProgress in interface AsyncStateWindowProcessor<Long>

Parameters:

currentKey - the current key of the operator used to return the result of accessing async state associated with the same key. If it is null, it means that the returns of asynchronous state requests for all keys will not be awaited.

progress - the current progress time

Returns:

the future of the flush operation about current key if the current key is not null, else a StateFutureUtils.completedVoidFuture() will be returned.

Throws:

Exception

prepareCheckpoint

public org.apache.flink.api.common.state.v2.StateFuture<Void> prepareCheckpoint()
                                                                         throws Exception

Description copied from interface: AsyncStateWindowProcessor

Performs a preparation before checkpoint. This usually flushes buffered data into state.

Specified by:

prepareCheckpoint in interface AsyncStateWindowProcessor<Long>

Throws:

Exception

clearWindow

public org.apache.flink.api.common.state.v2.StateFuture<Void> clearWindow(long timerTimestamp,
 Long windowEnd)
                                                                   throws Exception

Description copied from interface: AsyncStateWindowProcessor

Clear state and resources associated with the given window namespace.

Note: the key context has been set.

Specified by:

clearWindow in interface AsyncStateWindowProcessor<Long>

Parameters:

timerTimestamp - the fired timestamp

windowEnd - the window to clear

Throws:

Exception

close

public void close()
           throws Exception

Description copied from interface: WindowProcessor

The tear-down method of the function. It is called after the last call to the main working methods.

Specified by:

close in interface WindowProcessor<Long,AsyncStateWindowProcessor.AsyncStateContext<Long>>

Overrides:

close in class WindowAggProcessorBase<Long,AsyncStateWindowProcessor.AsyncStateContext<Long>>

Throws:

Exception

createWindowSerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<Long> createWindowSerializer()

Description copied from interface: WindowProcessor

Returns the serializer of the window type.

Specified by:

createWindowSerializer in interface WindowProcessor<Long,AsyncStateWindowProcessor.AsyncStateContext<Long>>