Package org.apache.flink.table.runtime.operators.window.tvf.operator

Class WindowTableFunctionOperatorBase

java.lang.Object

org.apache.flink.streaming.api.operators.AbstractStreamOperator<OUT>

org.apache.flink.table.runtime.operators.TableStreamOperator<RowData>

org.apache.flink.table.runtime.operators.window.tvf.operator.WindowTableFunctionOperatorBase

All Implemented Interfaces:

Serializable, CheckpointListener, Input<RowData>, KeyContext, KeyContextHandler, OneInputStreamOperator<RowData,RowData>, StreamOperator<RowData>, StreamOperatorStateHandler.CheckpointedStreamOperator, YieldingOperator<RowData>

Direct Known Subclasses:

AlignedWindowTableFunctionOperator, UnalignedWindowTableFunctionOperator

public abstract class WindowTableFunctionOperatorBase
extends TableStreamOperator<RowData>
implements OneInputStreamOperator<RowData,RowData>

The WindowTableFunctionOperatorBase acts as a table-valued function to assign windows for input row. Output row includes the original columns as well additional 3 columns named window_start, window_end, window_time to indicate the assigned window.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.table.runtime.operators.TableStreamOperator

TableStreamOperator.ContextImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected Counter	numNullRowTimeRecordsDropped
protected int	rowtimeIndex
protected ZoneId	shiftTimeZone	The shift timezone of the window, if the proctime or rowtime type is TIMESTAMP_LTZ, the shift timezone is the timezone user configured in TableConfig, other cases the timezone is UTC which means never shift when assigning windows.
protected GroupWindowAssigner<TimeWindow>	windowAssigner

Fields inherited from class org.apache.flink.table.runtime.operators.TableStreamOperator

ctx, currentWatermark

Fields inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

config, lastRecordAttributes1, lastRecordAttributes2, latencyStats, LOG, metrics, output, processingTimeService, stateHandler, stateKeySelector1, stateKeySelector2, timeServiceManager

Constructor Summary

Constructors

Constructor	Description
WindowTableFunctionOperatorBase(GroupWindowAssigner<TimeWindow> windowAssigner, int rowtimeIndex, ZoneId shiftTimeZone)

Method Summary

Modifier and Type	Method	Description
void	close()	This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.
protected void	collect(RowData inputRow, Collection<TimeWindow> allWindows)
Counter	getNumNullRowTimeRecordsDropped()
void	open()	This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.

Methods inherited from class org.apache.flink.table.runtime.operators.TableStreamOperator

computeMemorySize, processWatermark, useSplittableTimers

Methods inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

finish, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getStateKeySelector1, getStateKeySelector2, getTimeServiceManager, getUserCodeClassloader, hasKeyContext1, hasKeyContext2, initializeState, initializeState, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processRecordAttributes, processRecordAttributes1, processRecordAttributes2, processWatermark1, processWatermark2, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, reportOrForwardLatencyMarker, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setMailboxExecutor, setProcessingTimeService, setup, snapshotState, snapshotState

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.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

Methods inherited from interface org.apache.flink.streaming.api.operators.Input

processElement, processLatencyMarker, processRecordAttributes, processWatermark, processWatermarkStatus

Methods inherited from interface org.apache.flink.streaming.api.operators.KeyContext

getCurrentKey, setCurrentKey

Methods inherited from interface org.apache.flink.streaming.api.operators.KeyContextHandler

hasKeyContext

Methods inherited from interface org.apache.flink.streaming.api.operators.OneInputStreamOperator

setKeyContextElement

Methods inherited from interface org.apache.flink.streaming.api.operators.StreamOperator

finish, getMetricGroup, getOperatorAttributes, getOperatorID, initializeState, prepareSnapshotPreBarrier, setKeyContextElement1, setKeyContextElement2, snapshotState

Field Detail

shiftTimeZone

protected final ZoneId shiftTimeZone

The shift timezone of the window, if the proctime or rowtime type is TIMESTAMP_LTZ, the shift timezone is the timezone user configured in TableConfig, other cases the timezone is UTC which means never shift when assigning windows.

rowtimeIndex

protected final int rowtimeIndex

windowAssigner

protected final GroupWindowAssigner<TimeWindow> windowAssigner

numNullRowTimeRecordsDropped

protected transient Counter numNullRowTimeRecordsDropped

Constructor Detail

WindowTableFunctionOperatorBase

public WindowTableFunctionOperatorBase(GroupWindowAssigner<TimeWindow> windowAssigner,
                                       int rowtimeIndex,
                                       ZoneId shiftTimeZone)

Method Detail

open

public void open()
          throws Exception

Description copied from class: AbstractStreamOperator

This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.

The default implementation does nothing.

Specified by:

open in interface StreamOperator<RowData>

Overrides:

open in class TableStreamOperator<RowData>

Throws:

Exception - An exception in this method causes the operator to fail.

close

public void close()
           throws Exception

Description copied from interface: StreamOperator

This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.

This method is expected to make a thorough effort to release all resources that the operator has acquired.

NOTE:It can not emit any records! If you need to emit records at the end of processing, do so in the StreamOperator.finish() method.

Specified by:

close in interface StreamOperator<RowData>

Overrides:

close in class AbstractStreamOperator<RowData>

Throws:

Exception

collect

protected void collect(RowData inputRow,
                       Collection<TimeWindow> allWindows)

getNumNullRowTimeRecordsDropped

@VisibleForTesting
public Counter getNumNullRowTimeRecordsDropped()