org.apache.flink.table.runtime.operators.python

Class AbstractStatelessFunctionOperator<IN,OUT,UDFIN>

java.lang.Object

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

org.apache.flink.streaming.api.operators.python.AbstractPythonFunctionOperator<OUT>

org.apache.flink.streaming.api.operators.python.process.AbstractExternalPythonFunctionOperator<OUT>

org.apache.flink.table.runtime.operators.python.AbstractOneInputPythonFunctionOperator<IN,OUT>

org.apache.flink.table.runtime.operators.python.AbstractStatelessFunctionOperator<IN,OUT,UDFIN>

Type Parameters:

IN - Type of the input elements.

OUT - Type of the output elements.

UDFIN - Type of the UDF input type.

All Implemented Interfaces:

Serializable, CheckpointListener, BoundedOneInput, Input<IN>, KeyContext, KeyContextHandler, OneInputStreamOperator<IN,OUT>, SetupableStreamOperator<OUT>, StreamOperator<OUT>, StreamOperatorStateHandler.CheckpointedStreamOperator

Direct Known Subclasses:

AbstractArrowPythonAggregateFunctionOperator, AbstractPythonScalarFunctionOperator, PythonTableFunctionOperator

@Internal
public abstract class AbstractStatelessFunctionOperator<IN,OUT,UDFIN>
extends AbstractOneInputPythonFunctionOperator<IN,OUT>

Base class for all stream operators to execute Python Stateless Functions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteArrayInputStreamWithPos	bais Reusable InputStream used to holding the execution results to be deserialized.
protected DataInputViewStreamWrapper	baisWrapper InputStream Wrapper.
protected ByteArrayOutputStreamWithPos	baos Reusable OutputStream used to holding the serialized input elements.
protected DataOutputViewStreamWrapper	baosWrapper OutputStream Wrapper.
protected LinkedList<IN>	forwardedInputQueue The queue holding the input elements for which the execution results have not been received.
protected RowType	inputType The input logical type.
protected RowType	udfInputType The user-defined function input logical type.
protected RowType	udfOutputType The user-defined function output logical type.

Fields inherited from class org.apache.flink.streaming.api.operators.python.process.AbstractExternalPythonFunctionOperator

pythonFunctionRunner

Fields inherited from class org.apache.flink.streaming.api.operators.python.AbstractPythonFunctionOperator

bundleFinishedCallback, config, elementCount, lastFinishBundleTime, maxBundleSize, systemEnvEnabled

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

chainingStrategy, latencyStats, LOG, metrics, output, processingTimeService

Constructor Summary

Constructors

Constructor and Description
AbstractStatelessFunctionOperator(Configuration config, RowType inputType, RowType udfInputType, RowType udfOutputType)

Method Summary

Modifier and Type	Method and Description
abstract void	bufferInput(IN input) Buffers the specified input, it will be used to construct the operator result together with the user-defined function execution result.
abstract FlinkFnApi.CoderInfoDescriptor	createInputCoderInfoDescriptor(RowType runnerInputType)
abstract FlinkFnApi.CoderInfoDescriptor	createOutputCoderInfoDescriptor(RowType runnerOutType)
PythonFunctionRunner	createPythonFunctionRunner() Creates the PythonFunctionRunner which is responsible for Python user-defined function execution.
abstract FlinkFnApi.UserDefinedFunctions	createUserDefinedFunctionsProto() Gets the proto representation of the Python user-defined functions to be executed.
abstract UDFIN	getFunctionInput(IN element)
abstract String	getFunctionUrn()
void	open() This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g.
void	processElement(StreamRecord<IN> element) Processes one element that arrived on this input of the MultipleInputStreamOperator.
abstract void	processElementInternal(IN value)

Methods inherited from class org.apache.flink.table.runtime.operators.python.AbstractOneInputPythonFunctionOperator

endInput

Methods inherited from class org.apache.flink.streaming.api.operators.python.process.AbstractExternalPythonFunctionOperator

close, createPythonEnvironmentManager, emitResult, emitResults, getPythonEnv, invokeFinishBundle

Methods inherited from class org.apache.flink.streaming.api.operators.python.AbstractPythonFunctionOperator

checkInvokeFinishBundleByCount, finish, getConfiguration, getFlinkMetricContainer, isBundleFinished, prepareSnapshotPreBarrier, processWatermark, setCurrentKey

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

getChainingStrategy, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getTimeServiceManager, getUserCodeClassloader, hasKeyContext1, hasKeyContext2, initializeState, initializeState, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark1, processWatermark2, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, reportOrForwardLatencyMarker, setChainingStrategy, setKeyContextElement1, setKeyContextElement2, 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.streaming.api.operators.OneInputStreamOperator

setKeyContextElement

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

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

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.Input

processLatencyMarker, processWatermark, processWatermarkStatus

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

hasKeyContext

Field Detail

inputType

protected final RowType inputType

The input logical type.

udfInputType

protected final RowType udfInputType

The user-defined function input logical type.

udfOutputType

protected final RowType udfOutputType

The user-defined function output logical type.

forwardedInputQueue

protected transient LinkedList<IN> forwardedInputQueue

The queue holding the input elements for which the execution results have not been received.

bais

protected transient ByteArrayInputStreamWithPos bais

Reusable InputStream used to holding the execution results to be deserialized.

baisWrapper

protected transient DataInputViewStreamWrapper baisWrapper

InputStream Wrapper.

baos

protected transient ByteArrayOutputStreamWithPos baos

Reusable OutputStream used to holding the serialized input elements.

baosWrapper

protected transient DataOutputViewStreamWrapper baosWrapper

OutputStream Wrapper.

Constructor Detail

AbstractStatelessFunctionOperator

public AbstractStatelessFunctionOperator(Configuration config,
                                         RowType inputType,
                                         RowType udfInputType,
                                         RowType udfOutputType)

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<OUT>

Overrides:

open in class AbstractExternalPythonFunctionOperator<OUT>

Throws:

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

processElement

public void processElement(StreamRecord<IN> element)
                    throws Exception

Description copied from interface: Input

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

Throws:

Exception

createPythonFunctionRunner

public PythonFunctionRunner createPythonFunctionRunner()
                                                throws IOException

Description copied from class: AbstractExternalPythonFunctionOperator

Creates the PythonFunctionRunner which is responsible for Python user-defined function execution.

Specified by:

createPythonFunctionRunner in class AbstractExternalPythonFunctionOperator<OUT>

Throws:

IOException

bufferInput

public abstract void bufferInput(IN input)
                          throws Exception

Buffers the specified input, it will be used to construct the operator result together with the user-defined function execution result.

Throws:

Exception

getFunctionInput

public abstract UDFIN getFunctionInput(IN element)

createUserDefinedFunctionsProto

public abstract FlinkFnApi.UserDefinedFunctions createUserDefinedFunctionsProto()

Gets the proto representation of the Python user-defined functions to be executed.

getFunctionUrn

public abstract String getFunctionUrn()

createInputCoderInfoDescriptor

public abstract FlinkFnApi.CoderInfoDescriptor createInputCoderInfoDescriptor(RowType runnerInputType)

createOutputCoderInfoDescriptor

public abstract FlinkFnApi.CoderInfoDescriptor createOutputCoderInfoDescriptor(RowType runnerOutType)

processElementInternal

public abstract void processElementInternal(IN value)
                                     throws Exception

Throws:

Exception