org.apache.flink.table.runtime.functions.python

Class AbstractPythonScalarFunctionFlatMap

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.api.common.functions.RichFlatMapFunction<Row,Row>

org.apache.flink.table.runtime.functions.python.AbstractPythonStatelessFunctionFlatMap

org.apache.flink.table.runtime.functions.python.AbstractPythonScalarFunctionFlatMap

All Implemented Interfaces:

Serializable, FlatMapFunction<Row,Row>, Function, RichFunction, ResultTypeQueryable<Row>

Direct Known Subclasses:

ArrowPythonScalarFunctionFlatMap, PythonScalarFunctionFlatMap

@Internal
public abstract class AbstractPythonScalarFunctionFlatMap
extends AbstractPythonStatelessFunctionFlatMap

The abstract base RichFlatMapFunction used to invoke Python ScalarFunction functions for the old planner.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
PythonFunctionInfo[]	scalarFunctions The Python ScalarFunctions to be executed.

Fields inherited from class org.apache.flink.table.runtime.functions.python.AbstractPythonStatelessFunctionFlatMap

bais, baisWrapper, baos, forwardedInputQueue, forwardedInputSerializer, inputType, jobOptions, outputType, pythonFunctionRunner, resultCollector, userDefinedFunctionInputType, userDefinedFunctionOutputType

Constructor Summary

Constructors

Constructor and Description
AbstractPythonScalarFunctionFlatMap(Configuration config, PythonFunctionInfo[] scalarFunctions, RowType inputType, RowType outputType, int[] udfInputOffsets, int[] forwardedFields)

Method Summary

Modifier and Type	Method and Description
void	bufferInput(Row input)
int	getForwardedFieldsCount()
String	getFunctionUrn()
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(Configuration parameters) Initialization method for the function.

Methods inherited from class org.apache.flink.table.runtime.functions.python.AbstractPythonStatelessFunctionFlatMap

checkInvokeFinishBundleByCount, close, createPythonEnvironmentManager, emitResult, flatMap, getFlinkMetricContainer, getFunctionInput, getInputOutputCoderUrn, getProducedType, getPythonConfig, invokeFinishBundle, processElementInternal

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

scalarFunctions

public final PythonFunctionInfo[] scalarFunctions

The Python ScalarFunctions to be executed.

Constructor Detail

AbstractPythonScalarFunctionFlatMap

public AbstractPythonScalarFunctionFlatMap(Configuration config,
                                           PythonFunctionInfo[] scalarFunctions,
                                           RowType inputType,
                                           RowType outputType,
                                           int[] udfInputOffsets,
                                           int[] forwardedFields)

Method Detail

open

public void open(Configuration parameters)
          throws Exception

Description copied from interface: RichFunction

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The configuration object passed to the function can be used for configuration and initialization. The configuration contains all parameters that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(Configuration parameters) {
         this.searchString = parameters.getString("foo");
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

By default, this method does nothing.

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractPythonStatelessFunctionFlatMap

Parameters:

parameters - The configuration containing the parameters attached to the contract.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

See Also:

Configuration

getPythonEnv

public PythonEnv getPythonEnv()

Description copied from class: AbstractPythonStatelessFunctionFlatMap

Returns the PythonEnv used to create PythonEnvironmentManager..

Specified by:

getPythonEnv in class AbstractPythonStatelessFunctionFlatMap

bufferInput

public void bufferInput(Row input)

Specified by:

bufferInput in class AbstractPythonStatelessFunctionFlatMap

getForwardedFieldsCount

public int getForwardedFieldsCount()

Specified by:

getForwardedFieldsCount in class AbstractPythonStatelessFunctionFlatMap

getUserDefinedFunctionsProto

public FlinkFnApi.UserDefinedFunctions getUserDefinedFunctionsProto()

Description copied from class: AbstractPythonStatelessFunctionFlatMap

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

Specified by:

getUserDefinedFunctionsProto in class AbstractPythonStatelessFunctionFlatMap

getFunctionUrn

public String getFunctionUrn()

Specified by:

getFunctionUrn in class AbstractPythonStatelessFunctionFlatMap