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

Class PythonTableFunctionOperator

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<RowData,RowData,RowData>

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

All Implemented Interfaces:

Serializable, CheckpointListener, BoundedOneInput, Input<RowData>, KeyContext, OneInputStreamOperator<RowData,RowData>, SetupableStreamOperator<RowData>, StreamOperator<RowData>, StreamOperatorStateHandler.CheckpointedStreamOperator

@Internal
public class PythonTableFunctionOperator
extends AbstractStatelessFunctionOperator<RowData,RowData,RowData>

The Python TableFunction operator.

See Also:

Serialized Form

Field Summary

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

bais, baisWrapper, baos, baosWrapper, forwardedInputQueue, inputType, udfInputType, udfOutputType

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
PythonTableFunctionOperator(Configuration config, PythonFunctionInfo tableFunction, RowType inputType, RowType udfInputType, RowType udfOutputType, FlinkJoinType joinType, GeneratedProjection udtfInputGeneratedProjection)

Method Summary

Modifier and Type	Method and Description
void	bufferInput(RowData input) Buffers the specified input, it will be used to construct the operator result together with the user-defined function execution result.
FlinkFnApi.CoderInfoDescriptor	createInputCoderInfoDescriptor(RowType runnerInputType)
FlinkFnApi.CoderInfoDescriptor	createOutputCoderInfoDescriptor(RowType runnerOutType)
FlinkFnApi.UserDefinedFunctions	createUserDefinedFunctionsProto() Gets the proto representation of the Python user-defined functions to be executed.
void	emitResult(Tuple3<String,byte[],Integer> resultTuple) Sends the execution result to the downstream operator.
RowData	getFunctionInput(RowData element)
String	getFunctionUrn()
PythonEnv	getPythonEnv() Returns the PythonEnv used to create PythonEnvironmentManager..
void	open() This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g.
void	processElementInternal(RowData value)

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

createPythonFunctionRunner, processElement

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, emitResults, 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, initializeState, initializeState, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark1, processWatermark2, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, registerCounterOnOutput, 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

Constructor Detail

PythonTableFunctionOperator

public PythonTableFunctionOperator(Configuration config,
                                   PythonFunctionInfo tableFunction,
                                   RowType inputType,
                                   RowType udfInputType,
                                   RowType udfOutputType,
                                   FlinkJoinType joinType,
                                   GeneratedProjection udtfInputGeneratedProjection)

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 AbstractStatelessFunctionOperator<RowData,RowData,RowData>

Throws:

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

getPythonEnv

public PythonEnv getPythonEnv()

Description copied from class: AbstractExternalPythonFunctionOperator

Returns the PythonEnv used to create PythonEnvironmentManager..

Specified by:

getPythonEnv in class AbstractExternalPythonFunctionOperator<RowData>

getFunctionUrn

public String getFunctionUrn()

Specified by:

getFunctionUrn in class AbstractStatelessFunctionOperator<RowData,RowData,RowData>

createInputCoderInfoDescriptor

public FlinkFnApi.CoderInfoDescriptor createInputCoderInfoDescriptor(RowType runnerInputType)

Specified by:

createInputCoderInfoDescriptor in class AbstractStatelessFunctionOperator<RowData,RowData,RowData>

createOutputCoderInfoDescriptor

public FlinkFnApi.CoderInfoDescriptor createOutputCoderInfoDescriptor(RowType runnerOutType)

Specified by:

createOutputCoderInfoDescriptor in class AbstractStatelessFunctionOperator<RowData,RowData,RowData>

createUserDefinedFunctionsProto

public FlinkFnApi.UserDefinedFunctions createUserDefinedFunctionsProto()

Description copied from class: AbstractStatelessFunctionOperator

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

Specified by:

createUserDefinedFunctionsProto in class AbstractStatelessFunctionOperator<RowData,RowData,RowData>

bufferInput

public void bufferInput(RowData input)

Description copied from class: AbstractStatelessFunctionOperator

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

Specified by:

bufferInput in class AbstractStatelessFunctionOperator<RowData,RowData,RowData>

getFunctionInput

public RowData getFunctionInput(RowData element)

Specified by:

getFunctionInput in class AbstractStatelessFunctionOperator<RowData,RowData,RowData>

processElementInternal

public void processElementInternal(RowData value)
                            throws Exception

Specified by:

processElementInternal in class AbstractStatelessFunctionOperator<RowData,RowData,RowData>

Throws:

Exception

emitResult

public void emitResult(Tuple3<String,byte[],Integer> resultTuple)
                throws Exception

Description copied from class: AbstractExternalPythonFunctionOperator

Sends the execution result to the downstream operator.

Specified by:

emitResult in class AbstractExternalPythonFunctionOperator<RowData>

Throws:

Exception