SQL任务
SQL任务通过关联某个数据源,配置SQL脚本来执行SQL命令。常见应用场景是数据库或者大数据的取数或者数据分析。
注意事项
需要引擎版本3.0.1及以上,XXL-JOB Agent版本1.0.1及以上。
接入步骤
登录MSE XXL-JOB控制台,在顶部菜单栏选择地域。
在任务调度 > XXL-JOB版页面,单击目标实例(要求引擎版本>=3.0.1)。
在左侧导航栏选择应用管理,然后单击创建应用,应用类型选择普通应用,然后单击确定。
接入执行器,推荐使用MSE自研的执行器,支持SQL任务运行。
在左侧导航栏选择数据源管理,创建数据源。
在左侧导航栏选择任务管理,点击创建任务,任务类型选择SQL,选择对应的数据源类型和数据源实例;选择SQL类型为查询或更新,SQL 语句中填写对应的SQL脚本内容。
SQL任务配置项说明:
配置项 | 描述 | 示例 |
数据源类型 | 当前支持如下数据源类型: | MySQL |
数据源实例 | 选择当前任务需要操作的数据源 | test |
SQL类型 | 当前SQL任务脚本内容类型 | 查询 |
SQL 语句 | 实际执行脚本内容 | select count(*) as num from person where age > 18 |
前置SQL语句 | 主SQL执行前,前置执行的数据更新语句;必须为SQL更新脚本 | update person set age=age+1 where name='Bob' |
后置SQL语句 | 主SQL执行后,后置执行的数据更新语句;必须为SQL更新脚本 | delete from person where name='Bob' |
更新SQL脚本
在任务管理页面,运行模式这一列,点击编辑脚本,即可对SQL脚本内容进行编辑。
在任务列表中,目标任务的运行模式列会显示SQL标签和编辑脚本链接,单击编辑脚本即可打开脚本编辑器。
每次保存脚本可以自定义一个版本号,支持历史版本对比。
在脚本编辑器中,开启版本对比开关,并从右上角的版本下拉列表中选择历史版本号(如v1)。编辑器将以左右对比视图展示当前版本和历史版本(只读)的差异。
自定义参数配置
输入参数
在SQL脚本中通过${变量名}来获取参数值。参数值的来源:任务自定义输入参数、流程系统参数、流程上下文参数。
例如,在SQL 语句输入框中填写select count(*) as num from person where age > ${v_age},其中${v_age}为输入参数的变量引用。
在任务配置的自定义参数区域,配置对应的输入参数:参数名为v_age,方向选择IN,类型选择INTEGER,默认值填写实际值(如16)。可单击+ 添加参数增加更多参数。
输出参数
当前任务编排在流程中时,可配置输出参数将执行结果输出到流程实例上下文中,供后续节点使用相应的输出结果信息。
查询SQL返回单行时可通过输出参数key获取对应字段值输出。如下示例:将根据年龄获取对应的人数,映射至输出参数num。
例如,SQL语句为select count(*) as num from person where age > ${v_age},查询结果中的num字段即可作为输出参数的key。
在自定义参数区域,配置输出参数:参数名为num,方向选择OUT,类型选择INTEGER,value为选填项。
更新SQL则将更新行数值映射到自定义参数中唯一的输出参数key进行输出。如下示例:将名为Bob的人员年龄加1,并将更新的行数赋予到num输出参数。
例如,SQL语句为update person set age=age+1 where name = 'Bob',执行后返回的更新行数将映射至输出参数。
在自定义参数区域,配置输出参数:参数名为num,方向选择OUT,类型选择INTEGER,即可将更新行数输出到流程上下文中。