宏是 Cloud Data Fusion 插件属性配置中的占位符。它们由 ${ }
内包含的变量(例如 ${input_file_path}
)表示。如需为文件路径和表名称等元素启用动态配置,在运行时会将占位符替换为实际值。
查看插件的属性时,您可以向旁边带有 M 的任何属性字段添加宏。如需添加该宏,请点击 M。
如需了解详情,请参阅管理宏、偏好设置和运行时参数。
宏函数
除了宏之外,您还可以使用以下预定义的宏函数:
logicalStartTime()
secure()
逻辑开始时间函数
logicalStartTime()
宏函数以字符串值的形式返回流水线运行的逻辑开始时间。
如果未提供任何参数,则返回以毫秒为单位的开始时间。所有参数都是可选的。该函数将时间格式、偏移量和时区作为参数,并使用流水线的逻辑开始时间执行替换操作:
${logicalStartTime([timeFormat[,offset [,timezone])}
以下列表显示了 logicalStartTime()
的可选参数:
参数 | 说明 |
---|---|
timeFormat |
时间格式模式,采用 Java SimpleDateFormat 格式。 |
offset |
逻辑开始时间之前的时间偏移量。 |
timezone |
用于逻辑开始时间的时区。 |
示例
在此示例中,流水线运行的逻辑开始时间为 2020-01-01T00:00:00
,并且您提供了以下宏:
${logicalStartTime(yyyy-MM-dd'T'HH-mm-ss,1d-4h+30m)}
格式为 yyyy-MM-dd'T'HH-mm-ss
,且偏移量为逻辑开始时间之前的 1d-4h+30m
。在运行时,宏值会替换为 2019-12-31T03:30:00
,因为偏移值会转换为 20.5 小时。整个宏的计算结果为 2020 年 1 月 1 日午夜前 20.5 小时。
在基于文件的插件中使用 logicalStartTime()
此函数的最常用方法是在基于文件的插件中的 Path 字段中使用。
在文件名中包含流水线开始时间(以毫秒为单位)
如需在文件名中捕获实际开始时间(以毫秒为单位),请省略宏函数中的参数。
示例
在此示例中,您将在 Amazon S3 文件名中添加流水线开始时间(以毫秒为单位):
sales_012345671011.csv
在 Amazon S3 接收器属性中,在路径字段中输入以下值:
s3a://sales-data/sales_${logicalStartTime()}.csv
在文件名中包含当天的日期
您可以在文件名中使用 logicalStartTime()
宏函数来捕获当前日期。
示例
在此示例中,您将使用以下 S3 文件名捕获今天的日期:
s3a://sales-data/sales_20210204.csv
在 Amazon S3 接收器属性中,在路径字段中输入以下值:
s3a://sales-data/sales_${logicalStartTime(yyyyMMdd)}.csv
使用 logicalStartTime
向结构化记录添加时间戳字段
您可以使用添加字段转换和 logicalStartTime()
向结构化记录添加时间戳。
- 从 Cloud Data Fusion Hub 获取 Field Adder 转换插件。 部署插件后,该插件将在转换列表中显示为添加字段。
- 配置插件属性时,将时间戳添加到结构化记录中。例如,对于字段名称,请输入新字段的名称;对于字段值,请输入
logicalStartTime()
宏函数。
保护功能
secure()
宏函数接受单个键作为参数,并从 Secure Store 查找该键的关联字符串值。为了执行替换,以参数形式提供的密钥必须已经存在于安全存储区中。这对于使用敏感数据执行替换非常有用。
示例
在此示例中,对于连接到 MySQL 数据库的插件,请使用以下值配置密码属性字段:
${secure(password)}
此宏会在运行时从安全存储区提取密码。
递归宏
宏以递归方式引用其他宏,最多可引用十个级别。宏参数按照从最内层到最外层参数进行求值。
示例
在此示例中,您的服务器引用了主机名和端口。您需要提供以下运行时参数,其中最后一个参数是引用其他宏的宏:
- 主机名:
examplepetstore.com
- port:
9991
- server-address:
${hostname}:${port}
在流水线配置中,您可以使用以下表达式:
server-address: ${server-address}
在运行时,它会被替换为以下值:
examplepetstore.com:9991
后续步骤
详细了解宏、偏好设置和运行时参数。
了解如何使用插件模板。