最近更新时间:2022.09.07 11:50:10
首次发布时间:2022.07.26 11:41:18
通过界面向导的方式新建Query,您无需编写任何代码,在界面上勾选数据集相关配置即可快速生成Query。本文将为您介绍如何通过向导模式生成Query。
登录 DataLeap租户控制台 。
在 概览 界面顶部服务窗口,点击 数据服务 ,可快速进入到 数据服务 功能界面。
在上方导航栏中,点击 Query 进入界面。
左侧导航栏中,点击 新建Query,在弹窗中填写以下参数完成新建:
参数 | 说明 |
---|---|
类型 | 表查询类型,可选择向导式、脚本式、原生Query,此处选择向导式创建。 |
Query名称 | 输入Query名称,只允许英文,数字和下划线。 |
Query存放目录 | 选择Query存放的目录,下拉选择已创建的Query目录,目录创建方式详见:Query目录。 |
网络协议 | 仅支持HTTPS协议。 |
返回类型 | 仅支持JSON返回类型。 |
负责人 | 下拉选择Query负责人。 |
最大QPS | 设置每秒向服务发送的请求数量峰值,需正整数。 |
用途描述 | 输入该Query使用场景,方便后续管理。 |
初始Query版本 | 输入Query版本,三段式个位数,如1.0.0 。 |
版本描述 | 输入版本描述,方便后续多版本管理。 |
更多配置(可选) |
|
参数填写完整后,点击 确认 按钮,完成新建Query。
点击Query名称右侧的 更多 按钮,您可以进行以下操作:
详情:查看当前Query的详情,查看通用信息、版本信息、接口信息等。
编辑:进入当前Query编辑界面,配置Query的请求参数、返回参数等。
移动:移动当前Query到其他Query目录文件夹下。
删除:删除当前Query。
点击Query名称,进入编辑界面,选择数据集信息。
下拉选择,或输入关键字搜索 数据集 中创建的 数据集目录文件夹 名称。
下拉选择,或输入关键字搜索目录文件夹下已导入的数据集名称。
数据集相关操作详见:创建数据集。
点击右侧 新增参数,勾选设置请求参数和返回参数。
选择数据集后,新增参数弹窗会展现当前数据集所有字段信息,您可以根据需求,勾选相应的字段作为请求参数和返回参数,选择完后,右上角关闭弹窗即可添加参数成功。
并为参数设置操作符、示例值、缺省值和备注信息等。
请求参数列表:
参数 | 说明 |
---|---|
参数名称 | 输入请求参数名称,支持英文字符,_,数字。 |
参数类型 |
|
操作符 | 操作符表示请求参数和实际赋值之间的比较,支持以下操作符:
|
是否必须 | 该请求参数是否为必填项。 |
示例值 | 输入该请求参数的示例值。 |
缺省值 | 输入该请求参数的缺省值。 |
备注信息 | 为该请求参数的备注信息,方便后续管理。 |
操作 | 支持复制、删除当前的请求参数。 |
返回参数列表:
参数 | 说明 |
---|---|
参数名称 | 输入返回参数名称,支持英文字符,_,数字。 |
是否排序参数 | 当您这一列的返回参数中有多个值时,选择是否需要排序返回该字段,支持增序、降序排列返回。 |
示例值 | 输入该返回参数的示例值。 |
缺省值 | 输入该返回参数的缺省值。 |
备注信息 | 输入该返回参数的备注信息,方便后续管理。 |
操作 | 支持删除当前的返回参数。 |
点击 查看所选数据集参数 按钮,您可以再次查看所选的请求参数和返回参数列表,也可以再次选择需要的参数。
开启分页:开启后,系统将会自动添加pageSize和pageNum两个请求参数。
数据缓存时间:用于设定服务查询对结果集的缓存时间。
系统策略:默认600s 缓存时间。
手动设置缓存时间,单位:秒。
关闭缓存时间。
数据集、参数等信息配置完成后,您可以点击右上角 保存 按钮,保存该Query:
点 保存 按钮,直接保存当前版本。
若当前线上有已发布的版本,直接修改会影响调用,您可以选择以下保存方式:
另存为新的版本:将当前的修改另存为新版本保存,在弹窗中填写 新版本号 即可完成保存。
另存为新的Query:将当前的修改另存为新Query保存,在弹窗中填写 Query基本信息 完成新建。
或者在右侧 版本信息 内可将当前版本Query下线之后,再进行修改保存。
点击界面右侧导航栏中的 基本信息,即可实现基本信息的修改,支持修改Query名称、负责人、QPS限流、SLA、PCT99、超时等Query基本信息,修改完成后,点击 保存基本信息 按钮,即可完成修改。
点击界面右侧导航栏中的 版本信息,记录历史各Query版本:
版本:
您可以点击历史版本号,编辑界面将会切换到历史版本。
您也可以在Query编辑界面上方的导航栏中,选择历史版本号,点击进入编辑。
版本对比:您可以勾选两个版本号,点击右上角 对比 按钮,进行基本信息、参数等对比。
提交日期:您可以点击说明栏的 排序 按钮,根据日期先后进行排序。
操作栏:
下线-线上:将线上已有的版本下线操作。
发布-线上:将未发布的版本操作上线,会覆盖之前已发布的版本。
详情:点击后跳转到详情界面,查看Query的通用信息、版本信息、HTTPS接口信息等详情。
删除:允许删除未发布的版本。