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

Class AbstractPythonScalarFunctionOperator<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.AbstractOneInputPythonFunctionOperator<IN,OUT>

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

org.apache.flink.table.runtime.operators.python.scalar.AbstractPythonScalarFunctionOperator<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, org.apache.flink.api.common.state.CheckpointListener, org.apache.flink.streaming.api.operators.BoundedOneInput, org.apache.flink.streaming.api.operators.Input<IN>, org.apache.flink.streaming.api.operators.KeyContext, org.apache.flink.streaming.api.operators.OneInputStreamOperator<IN,OUT>, org.apache.flink.streaming.api.operators.SetupableStreamOperator<OUT>, org.apache.flink.streaming.api.operators.StreamOperator<OUT>, org.apache.flink.streaming.api.operators.StreamOperatorStateHandler.CheckpointedStreamOperator, org.apache.flink.util.Disposable

Direct Known Subclasses:

AbstractRowDataPythonScalarFunctionOperator, AbstractRowPythonScalarFunctionOperator

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

Base class for all stream operators to execute Python ScalarFunctions. It executes the Python ScalarFunctions in separate Python execution environment.

The inputs are assumed as the following format: {{{ +------------------+--------------+ | forwarded fields | extra fields | +------------------+--------------+ }}}.

The Python UDFs may take input columns directly from the input row or the execution result of Java UDFs: 1) The input columns from the input row can be referred from the 'forwarded fields'; 2) The Java UDFs will be computed and the execution results can be referred from the 'extra fields'.

The outputs will be as the following format: {{{ +------------------+-------------------------+ | forwarded fields | scalar function results | +------------------+-------------------------+ }}}.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	forwardedFields The offset of the fields which should be forwarded.
protected org.apache.flink.table.functions.python.PythonFunctionInfo[]	scalarFunctions The Python ScalarFunctions to be executed.

Fields inherited from class org.apache.flink.table.runtime.operators.python.AbstractStatelessFunctionOperator

bais, baisWrapper, baos, baosWrapper, forwardedInputQueue, inputType, outputType, userDefinedFunctionInputOffsets, userDefinedFunctionInputType, userDefinedFunctionOutputType

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

elementCount, maxBundleSize, pythonFunctionRunner

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

chainingStrategy, latencyStats, LOG, metrics, output, processingTimeService

Method Summary

Modifier and Type	Method and Description
String	getFunctionUrn()
String	getInputOutputCoderUrn()
org.apache.flink.table.functions.python.PythonEnv	getPythonEnv() Returns the PythonEnv used to create PythonEnvironmentManager..
FlinkFnApi.UserDefinedFunctions	getUserDefinedFunctionsProto() Gets the proto representation of the Python user-defined functions to be executed.
void	open()

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

bufferInput, createPythonFunctionRunner, getFunctionInput, processElement, processElementInternal

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

endInput

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

checkInvokeFinishBundleByCount, close, createPythonEnvironmentManager, dispose, emitResult, emitResults, getConfig, getFlinkMetricContainer, getPythonConfig, invokeFinishBundle, isBundleFinished, prepareSnapshotPreBarrier, processWatermark, setCurrentKey, setPythonConfig

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, initializeState, initializeState, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark1, processWatermark2, 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, dispose, 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

Field Detail

scalarFunctions

protected final org.apache.flink.table.functions.python.PythonFunctionInfo[] scalarFunctions

The Python ScalarFunctions to be executed.

forwardedFields

protected final int[] forwardedFields

The offset of the fields which should be forwarded.

Method Detail

open

public void open()
          throws Exception

Specified by:

open in interface org.apache.flink.streaming.api.operators.StreamOperator<OUT>

Overrides:

open in class AbstractStatelessFunctionOperator<IN,OUT,UDFIN>

Throws:

Exception

getPythonEnv

public org.apache.flink.table.functions.python.PythonEnv getPythonEnv()

Description copied from class: AbstractPythonFunctionOperator

Returns the PythonEnv used to create PythonEnvironmentManager..

Specified by:

getPythonEnv in class AbstractPythonFunctionOperator<OUT>

getUserDefinedFunctionsProto

public FlinkFnApi.UserDefinedFunctions getUserDefinedFunctionsProto()

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

Specified by:

getUserDefinedFunctionsProto in class AbstractStatelessFunctionOperator<IN,OUT,UDFIN>

getFunctionUrn

public String getFunctionUrn()

Specified by:

getFunctionUrn in class AbstractStatelessFunctionOperator<IN,OUT,UDFIN>

getInputOutputCoderUrn

public String getInputOutputCoderUrn()

Specified by:

getInputOutputCoderUrn in class AbstractStatelessFunctionOperator<IN,OUT,UDFIN>