Table function 的输入可以是 0、1，以及多个标量（scalar values），但是输出的是多行，也可以认为输出的是一个二维表。

如何实现

1. 在pom.xml中添加flink-table-common的依赖。version 可以根据任务选择的 Flink 引擎填写对应的版本

   1. Flink 1.16 版本建议选择 1.16.3
   2. Flink 1.17 版本建议选择 1.17.2

   <dependency>
       <groupId>org.apache.flink</groupId>
       <artifactId>flink-table-common</artifactId>
       <version>${flink.version}</version>
       <scope>provided</scope>
   </dependency>
   

2. 代码实现。
   通过继承org.apache.flink.table.functions.TableFunction实现，并且需要实现一个或多个 eval 函数。eval 函数输入可以是多个参数。

示例 Demo

本文提供一个简单的 table function 的示例，作用是将一个 Row array 切分为多行。

public class SplitTableFunction extends TableFunction<Row> {
  public void eval(Row[] rows) {
    for (Row row : rows) {
      // collect 一次相当于输入一行。
      collect(row);
    }
  }

  // 如果输入的参数类型是复杂类型，需要通过 getParameterTypes 指定入参的类型。
  @Override
  public TypeInformation<?>[] getParameterTypes(Class<?>[] signature) {
    TypeInformation[] typeInformation = new TypeInformation[1];
    // 入参是 Row 类型的数组，Row 第一列是 int, 第二列是 String。
    typeInformation[0] = Types.OBJECT_ARRAY(Types.ROW(Types.INT, Types.STRING));
    return typeInformation;
  }

  // 如果返回的数据类型是复杂类型，需要通过 getResultType 指定返回数据的类型。
  @Override
  public TypeInformation<Row> getResultType() {
  // 返回类型是 Row，其中 第一列名称是 id, 类型是 int, 第二列名称是 name, 类型是 String。
    TypeInformation[] typeInformations = new TypeInformation[] {Types.INT, Types.STRING}; 
    String[] names = new String[] {"id", "name"};
    return Types.ROW_NAMED(names, typeInformations);
  }
}

如何使用

如何使用自定义的 Table function，请参见创建自定义函数。