配置代码模板

更新时间:
复制为 MD 格式

代码模板是在创建节点后,默认展示在该节点代码编辑器界面最前端的内容,包括节点类型、节点的创建用户、节点的创建时间等信息,帮助您快速标记该节点。通常用于业务层进行节点管理。本文为您介绍DataWorks支持的代码模板类型及如何设置代码模板。

使用限制

空间管理员可以修改代码模板。如果目标用户需要修改代码模板,则可被授予空间管理员角色权限,授权详情请参见添加空间成员并管理成员角色权限

设置代码模板

  1. 进入代码模板。

    1. 登录DataWorks控制台,切换至目标地域后,单击左侧导航栏的数据开发与运维 > 数据开发,在下拉框中选择对应工作空间后单击进入数据开发

    2. 单击左侧导航栏底部的设置图标,进入设置页面。

    3. 设置页面,单击切换至代码模板页签,进入代码模板页面。

  2. 设置代码模板。

    代码模板页面,单击相应代码类型后的编辑,即可根据需要修改该类型节点的代码模板。修改并保存后,后续在数据开发(DataStudio)创建的相应节点便会呈现该模板的配置内容,您可基于该内容进行相关业务管理操作。DataWorks支持的模板类型,请参见支持的代码模板类型

    ODPS SQL节点示例,该节点编辑页面代码模板展示如下。

    --odps sql
    --**********************************************************
    --author: xxx
    --create time:2023-06-26 11:33:05
    --**********************************************************

支持的代码模板类型

在定义代码模板时,您可使用相关变量来记录新建该类型任务时的相关信息,目前支持在模板中定义的变量有:

  • author:记录节点创建人。

  • createTime:记录节点创建时间。

DataWorks支持的节点类型及为该节点提供的默认模板如下表。

引擎类型

节点类型

默认模板

MaxCompute

ODPS Script

ODPS Script 代码模板的默认内容包含注释行 --author:${author}--create time:${createTime} 两个变量占位符,用于自动填充作者名和创建时间。在代码模板弹窗中编辑完成后,单击保存

ODPS SQL

代码模板弹窗中,默认模板内容包含 --odps sql 标识行以及模板变量 --author:${author}--create time:${createTime},编辑完成后单击保存

ODPS MR

该类型的代码模板默认包含 -odps mr-author:${author}-create time:${createTime} 等变量信息,编辑完成后单击 保存 即可生效。

PyODPS 2

PyODPS 2 的代码模板默认包含提示信息:避免使用 open_readerto_pandas 等方法从 MaxCompute 下载大量数据,建议使用 PyODPS DataFrame 或 MaxCompute SQL 进行数据处理。参考链接:https://developer.aliyun.com/article/745029。单击保存可保存模板内容。

PyODPS 3

PyODPS 3 代码模板的默认内容为提示信息,建议避免从 MaxCompute 下载大量数据,相关方法包括表或实例的 open_reader 和 DataFrame 的 to_pandas,推荐使用基于 MaxCompute 表创建的 PyODPS DataFrame 或直接使用 MaxCompute SQL。参考文档:https://developer.aliyun.com/article/745029。

EMR

EMR MR

EMR MR节点的代码模板包含变量占位符 --author:${author}--create time:${createTime},并提示 EMR MR node can only run on exclusive resource groups.。编辑完成后单击保存

EMR Shell

代码模板弹窗中显示默认模板内容,包含 --author:${author}--create time:${createTime} 等注释行,以及提示 EMR Shell node can only run on exclusive resource groups.。编辑完成后单击保存取消

EMR Presto

EMR Presto 代码模板中包含占位变量 ${author}(作者)和 ${createTime}(创建时间),并提示 EMR Presto node can only run on exclusive resource groups(EMR Presto 节点只能运行在独享资源组上)。单击保存即可保存模板。

EMR Spark Streaming

EMR Spark Streaming 节点的默认代码模板包含注释行 --author:${author}--create time:${createTime},以及提示 --EMR Spark Streaming node can only run on exclusive resource groups.。编辑完成后单击保存

EMR Trino

EMR Trino 代码模板默认包含注释行 --author:${author}--create time:${createTime} 两个变量占位符,以及说明 --EMR Trino node can only run on exclusive resource groups.,编辑完成后单击保存

EMR Hive

EMR Hive节点的代码模板默认包含作者(${author})和创建时间(${createTime})参数,并提示EMR Hive节点只能在独享资源组上运行。编辑完成后,单击保存

EMR Spark

EMR Spark 节点的默认代码模板包含作者(${author})和创建时间(${createTime})变量,并提示 EMR Spark 节点仅支持在独享资源组上运行。

EMR Spark SQL

EMR Spark SQL 节点的默认代码模板包含模板变量 --author:${author}--create time:${createTime},并提示 EMR Spark SQL 节点仅支持在独享资源组上运行。在代码模板弹窗中编辑模板内容后,单击保存即可生效。

EMR Impala

EMR Impala 的代码模板包含注释头信息:作者占位变量 ${author}、创建时间占位变量 ${createTime},以及提示 EMR Impala node can only run on exclusive resource groups.

cdh

CDH Hive

CDH Hive 的代码模板包含模板变量 --author:${author}--create time:${createTime},并提示 CDH Hive 节点仅支持在独享资源组上运行。在弹窗中编辑模板内容后,单击保存完成配置。

CDH Spark

CDH Spark 代码模板包含注释头部,其中定义了 --author:${author}--create time:${createTime} 等模板变量,并提示 CDH Spark node can only run on exclusive resource groups.。编辑完成后单击 保存 按钮。

CDH MR

代码模板内容包含注释头 --CDH MR,变量占位符 --author:${author}--create time:${createTime},以及提示 --CDH MR node can only run on exclusive resource groups.

CDH Presto

CDH Presto 代码模板内容包含注释行 --author:${author}--create time:${createTime} 以及说明 CDH Presto node can only run on exclusive resource groups.

CDH Impala

CDH Impala 的代码模板包含变量 --author:${author}--create time:${createTime},并注明 CDH Impala node can only run on exclusive resource groups.。在弹窗中编辑完成后,单击保存

Hologres AI助手

Hologres SQL

Hologres SQL 代码模板默认包含注释行 --author:${author}--create time:${createTime} 变量占位符,编辑完成后单击保存

其他

Shell

其他Shell的代码模板包含 #!/bin/bash 声明行,以及 ${author}(作者)和 ${createTime}(创建时间)两个变量占位符。编辑完成后单击保存

ClickHouse SQL

代码模板内容为 SQL 注释头,包含 --author:${author}--create time:${createTime} 占位符,编辑完成后单击保存

HTTP触发器

HTTP 触发器的默认代码模板包含以下注释:--HTTP Trigger 标题行、--author:${author}--create time:${createTime} 两个变量占位行,以及功能说明——HTTP Trigger 是一种虚拟节点,可通过调用 DataWorks OpenAPI RunTriggerNode 触发其子节点运行,通常用于与用户自有系统对接。详情请参见 帮助文档