Transform

Transform模块帮助用户根据表中的数据列进行数据列的删除和扩展。
此外，它还可以帮助用户在同步过程中过滤一些不必要的数据。

参数

为了描述转换规则，可以使用以下参数：

可以在一个管道 YAML 文件中声明多个规则。

元数据字段

字段定义

有一些隐藏列用于访问元数据信息。它们仅在转换规则中明确引用时才会生效。

元数据关系

函数

Flink CDC 使用 Calcite 解析表达式，并使用 Janino 脚本通过函数调用来评估表达式。

比较函数

逻辑函数

字符串函数

时间函数

条件函数

示例

添加计算列

求值表达式可用于生成新列。例如，如果我们想基于数据库 mydb 中的表 web_order 附加两个计算列，我们可以定义一个转换规则，如下所示：

transform:
  - source-table: mydb.web_order
    projection: id, order_id, UPPER(product_name) as product_name, localtimestamp as new_timestamp
    description: append calculated columns based on source table

参考元数据列

我们可以在投影表达式中引用元数据列。例如，给定数据库 mydb 中的表 web_order，我们可以定义转换规则如下：

transform:
  - source-table: mydb.web_order
    projection: id, order_id, __namespace_name__ || '.' || __schema_name__ || '.' || __table_name__ identifier_name
    description: access metadata columns from source table

使用通配符投影所有字段

通配符 (*) 可用于引用表中的所有字段。例如，给定数据库 mydb 中的两个表 web_order 和 app_order，我们可以定义转换规则如下：

transform:
  - source-table: mydb.web_order
    projection: \*, UPPER(product_name) as product_name
    description: project fields with wildcard character from source table
  - source-table: mydb.app_order
    projection: UPPER(product_name) as product_name, *
    description: project fields with wildcard character from source table

注意：当表达式开头出现 * 字符时，需要使用转义反斜杠。

添加过滤规则

使用引用列在数据库mydb中的表web_order中添加过滤规则时，我们可以定义一个转换规则如下：

transform:
  - source-table: mydb.web_order
    filter: id > 10 AND order_id > 100
    description: filtering rows from source table

计算列也可以用于过滤条件。例如，给定数据库 mydb 中的表 web_order，我们可以定义转换规则如下：

transform:
  - source-table: mydb.web_order
    projection: id, order_id, UPPER(province) as new_province 
    filter: new_province = 'SHANGHAI'
    description: filtering rows based on computed columns

重新分配主键

我们可以在转换规则中重新分配主键。例如，给定数据库 mydb 中的表 web_order，我们可以定义转换规则如下：

transform:
  - source-table: mydb.web_order
    projection: id, order_id
    primary-keys: order_id
    description: reassign primary key example

还支持复合主键：

transform:
  - source-table: mydb.web_order
    projection: id, order_id, UPPER(product_name) as product_name
    primary-keys: order_id, product_name
    description: reassign composite primary keys example

重新分配分区键

我们可以在转换规则中重新分配分区键。例如，给定数据库 mydb 中的表 web_order，我们可以定义转换规则如下：

transform:
  - source-table: mydb.web_order
    projection: id, order_id, UPPER(product_name) as product_name
    partition-keys: product_name
    description: reassign partition key example

指定表创建配置

可以在转换规则中定义额外选项，这些选项将在创建下游表时应用。给定数据库 mydb 中的表 web_order，我们可以定义转换规则如下：

transform:
  - source-table: mydb.web_order
    projection: id, order_id, UPPER(product_name) as product_name
    table-options: comment=web order
    description: auto creating table options example

提示：table-options的格式为key1=value1,key2=value2。

分类映射

可以定义多个转换规则来对输入数据行进行分类并应用不同的处理。只有第一个匹配的转换规则才会应用。例如，我们可以定义如下转换规则：

transform:
  - source-table: mydb.web_order
    projection: id, order_id
    filter: UPPER(province) = 'SHANGHAI'
    description: classification mapping example
  - source-table: mydb.web_order
    projection: order_id as id, id as order_id
    filter: UPPER(province) = 'BEIJING'
    description: classification mapping example

用户定义函数

用户定义函数 (UDF) 可用于转换规则。

如果满足以下条件，类可用作 UDF：

• 实现 org.apache.flink.cdc.common.udf.UserDefinedFunction 接口
• 具有无参数的公共构造函数
• 至少有一个名为 eval 的公共方法

它还可以：

• 覆盖 getReturnType 方法以指示其返回 CDC 类型
• 覆盖 open 和 close 方法以执行一些初始化和清理工作

例如，这是一个有效的 UDF 类：

public class AddOneFunctionClass implements UserDefinedFunction {
    
    public Object eval(Integer num) {
        return num + 1;
    }
    
    @Override
    public DataType getReturnType() {
        return DataTypes.INT();
    }
    
    @Override
    public void open() throws Exception {
        // ...
    }

    @Override
    public void close() throws Exception {
        // ...
    }
}

为了简化从 Flink SQL 到 Flink CDC 的迁移，Flink ScalarFunction 也可以用作转换 UDF，但有一些限制：

• 不支持具有带参数的构造函数的 ScalarFunction。
• ScalarFunction 中的 Flink 样式类型提示将被忽略。
• 不会调用打开/关闭生命周期钩子。

可以通过添加用户定义函数块来注册 UDF 类：

pipeline:
  user-defined-function:
    - name: addone
      classpath: org.apache.flink.cdc.udf.examples.java.AddOneFunctionClass
    - name: format
      classpath: org.apache.flink.cdc.udf.examples.java.FormatFunctionClass

请注意，给定的类路径必须是完全限定的，并且相应的 jar 文件必须包含在 Flink /lib 文件夹中，或者使用 flink-cdc.sh --jar 选项传递。

正确注册后，UDF 可以在投影和过滤表达式中使用，就像内置函数一样：

transform:
  - source-table: db.\.*
    projection: "*, inc(inc(inc(id))) as inc_id, format(id, 'id -> %d') as formatted_id"
    filter: inc(id) < 100

已知限制

• 目前，转换不适用于路由规则。它将在未来版本中得到支持。
• 计算列不能引用最终投影结果中不存在的修剪列。这将在未来版本中修复。
• 不支持具有不同架构的表的常规匹配。如有必要，需要编写多个规则。