参数配置

通过参数配置,可以对NotebookSQL查询中的SQL代码所使用的参数变量进行赋值。在SQL代码运行时,参数变量将自动被替换为相应的值。本文为您介绍如何配置参数。

操作步骤

以下操作步骤SQL查询为例,NotebookSQL查询任务的参数配置操作路径相同。

  1. Dataphin首页的顶部菜单栏中,选择分析 > SQL查询/Notebook

  2. SQL查询列表中,选择待配置参数的目标任务,在该任务的编辑区域中,单击顶部的image..png图标,进入参数配置对话框。

  3. 在属性面板的参数配置对话框中,配置任务的参数信息。

    字段

    描述

    数据源模式

    数据源SQL查询支持配置数据源模式。若数据源为Dev-Prod模式,支持选择开发生产;若数据源为Basic模式,仅支持选择生产。

    重要

    若选择生产,执行语句后将改变生产环境数据,请谨慎操作。

    参数名称

    参数名称为您在SQL代码中定义的变量名称。在SQL您可以通过表达式方式新增参数,系统将自动加载SQL中已有的参数。表达式格式${变量名}

    参数类型

    单击参数类型下拉框,支持修改参数的类型。包括全局变量空间名称变量本地变量跨节点变量非变量类型更多信息,请参见参数名称

    选中多个参数或全选后,单击参数列表底部的修改参数类型,可批量修改参数类型。

    说明
    • 出于数据安全考虑,账号密码类型的全局变量在此无法使用,将被视作本地变量,需要手动赋值。

    • 若引用了开启权限管控的全局变量,系统将自动校验当前用户是否拥有权限,无权限的全局变量将以image图标标识,您可单击申请权限,跳转至权限管理 > 变量权限管理页面进行权限申请。

    • 分析平台内不支持空间名称变量。如果variable_name与某个生产项目或者生产板块的名称一致,会被视作本地变量。

    参数值

    请输入变量所需替换的参数值。最长支持256位,支持填充空值。您也可以针对日期时间进行运算。具体操作,请参见变量赋值

    操作

    支持转为本地变量和忽略操作。

    • 转为本地变量:参数配置时如果您的变量与某个全局变量名称一致,会被系统优先视作引用了全局变量,您可单击对应参数操作列的image图标,将其类型转换为本地变量,或者将本地变量转换为全局变量。

    • 忽略:如果您代码中${变量名}是代码内容的一部分,而不是变量,可单击对应参数操作列的image图标,忽略该变量。

  4. 单击确定

    重要

    单个SQL运行时,仅需配置当前SQL中未配置的参数,且配置的值将在该任务中全局生效。