Package org.apache.flink.table.runtime.operators.join.temporal

Class TemporalProcessTimeJoinOperator

java.lang.Object

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

org.apache.flink.table.runtime.operators.join.temporal.BaseTwoInputStreamOperatorWithStateRetention

org.apache.flink.table.runtime.operators.join.temporal.TemporalProcessTimeJoinOperator

All Implemented Interfaces:

Serializable, CheckpointListener, KeyContext, KeyContextHandler, StreamOperator<RowData>, StreamOperatorStateHandler.CheckpointedStreamOperator, Triggerable<Object,VoidNamespace>, TwoInputStreamOperator<RowData,RowData,RowData>, YieldingOperator<RowData>

public class TemporalProcessTimeJoinOperator
extends BaseTwoInputStreamOperatorWithStateRetention

The operator to temporal join a stream on processing time.

For temporal TableFunction join (LATERAL TemporalTableFunction(o.proctime)) and temporal table join (FOR SYSTEM_TIME AS OF), they can reuse same processing-time operator implementation, the differences between them are: (1) The temporal TableFunction join only supports single column in primary key but temporal table join supports arbitrary columns in primary key. (2) The temporal TableFunction join only supports inner join, temporal table join supports both inner join and left outer join.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.table.runtime.operators.join.temporal.BaseTwoInputStreamOperatorWithStateRetention

stateCleaningEnabled

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
TemporalProcessTimeJoinOperator(InternalTypeInfo<RowData> rightType, GeneratedJoinCondition generatedJoinCondition, long minRetentionTime, long maxRetentionTime, boolean isLeftOuterJoin)

Method Summary

Modifier and Type	Method	Description
void	cleanupState(long time)	The method to be called when a cleanup timer fires.
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.
void	onEventTime(InternalTimer<Object,VoidNamespace> timer)	Invoked when an event-time timer fires.
void	open()	This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.
void	processElement1(StreamRecord<RowData> element)	Processes one element that arrived on the first input of this two-input operator.
void	processElement2(StreamRecord<RowData> element)	Processes one element that arrived on the second input of this two-input operator.

Methods inherited from class org.apache.flink.table.runtime.operators.join.temporal.BaseTwoInputStreamOperatorWithStateRetention

cleanupLastTimer, onProcessingTime, registerProcessingCleanupTimer, 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, processWatermark, 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.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.StreamOperator

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

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

processLatencyMarker1, processLatencyMarker2, processRecordAttributes1, processRecordAttributes2, processWatermark1, processWatermark2, processWatermarkStatus1, processWatermarkStatus2

Constructor Detail

TemporalProcessTimeJoinOperator

public TemporalProcessTimeJoinOperator(InternalTypeInfo<RowData> rightType,
                                       GeneratedJoinCondition generatedJoinCondition,
                                       long minRetentionTime,
                                       long maxRetentionTime,
                                       boolean isLeftOuterJoin)

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 BaseTwoInputStreamOperatorWithStateRetention

Throws:

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

processElement1

public void processElement1(StreamRecord<RowData> element)
                     throws Exception

Description copied from interface: TwoInputStreamOperator

Processes one element that arrived on the first input of this two-input operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Throws:

Exception

processElement2

public void processElement2(StreamRecord<RowData> element)
                     throws Exception

Description copied from interface: TwoInputStreamOperator

Processes one element that arrived on the second input of this two-input operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Throws:

Exception

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

cleanupState

public void cleanupState(long time)

The method to be called when a cleanup timer fires.

Specified by:

cleanupState in class BaseTwoInputStreamOperatorWithStateRetention

Parameters:

time - The timestamp of the fired timer.

onEventTime

public void onEventTime(InternalTimer<Object,VoidNamespace> timer)
                 throws Exception

Invoked when an event-time timer fires.

Throws:

Exception