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

Class ArrowPythonScalarFunctionFlatMap

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

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

All Implemented Interfaces:

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

@Internal
public final class ArrowPythonScalarFunctionFlatMap
extends AbstractPythonScalarFunctionFlatMap

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

See Also:

Serialized Form

Field Summary

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

scalarFunctions

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

bais, baisWrapper, forwardedInputQueue, forwardedInputSerializer, inputType, jobOptions, outputType, resultCollector, userDefinedFunctionInputType, userDefinedFunctionOutputType, userDefinedFunctionResultQueue, userDefinedFunctionTypeSerializer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down method for the user code.
PythonFunctionRunner<Row>	createPythonFunctionRunner()
void	emitResults()
void	open(Configuration parameters) Initialization method for the function.

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

bufferInput, getForwardedFieldsCount, getPythonEnv

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

createPythonEnvironmentManager, flatMap, getFlinkMetricContainer, getProducedType, getPythonConfig

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

Constructor Detail

ArrowPythonScalarFunctionFlatMap

public ArrowPythonScalarFunctionFlatMap(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 AbstractPythonScalarFunctionFlatMap

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

close

public void close()
           throws Exception

Description copied from interface: RichFunction

Tear-down method for the user code. It is called after the last call to the main working methods (e.g. map or join). For functions that are part of an iteration, this method will be invoked after each iteration superstep.

This method can be used for clean up work.

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractPythonStatelessFunctionFlatMap

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.

createPythonFunctionRunner

public PythonFunctionRunner<Row> createPythonFunctionRunner()
                                                     throws IOException

Specified by:

createPythonFunctionRunner in class AbstractPythonStatelessFunctionFlatMap

Throws:

IOException

emitResults

public void emitResults()
                 throws IOException

Specified by:

emitResults in class AbstractPythonStatelessFunctionFlatMap

Throws:

IOException