脚本式Query

根据实际业务场景，您可以通过自定义SQL的脚本模式，自行编写API的查询SQL，实现更复杂的查询需求。本文为您介绍如何通过脚本模式生成API。

1 使用前提

• 已完成相关数据集的创建，操作详见：创建数据集。

2 新建Query

1. 登录 DataLeap租户控制台 。

2. 在 概览 界面顶部服务窗口，点击 数据服务 ，可快速进入到 数据服务 功能界面。

3. 在上方导航栏中，点击 Query 进入界面。
   

4. 左侧导航栏中，点击 新建Query，在弹窗中填写以下参数完成新建：

5. 参数填写完整后，点击 确认 按钮，完成新建Query。

6. 点击Query名称右侧的 更多 按钮，您可以进行以下操作：

   • 详情：查看当前Query的详情，查看通用信息、版本信息、接口信息等。

   • 编辑：进入当前Query编辑界面，配置Query的请求参数、返回参数等。

   • 移动：移动当前Query到其他Query目录文件夹下。

   • 删除：删除当前Query。

3 配置Query

3.1 选择数据集

1. 点击Query名称，进入编辑界面，选择数据集信息。

2. 下拉选择，或输入关键字搜索 数据集 中创建的 数据集目录文件夹 名称。

3. 下拉选择，或输入关键字搜索目录文件夹下已导入的数据集名称。

数据集相关操作详见：创建数据集

3.2 参数设置

3.2.1 编辑器选择

脚本式API需要您在编辑器自行编写Query，脚本编辑目前支持 SQL编辑器 和 XML编辑器， 您可以在下方入口进行切换：

3.2.2 编辑器工具栏

示例代码：
select
    runoob_id,
    runoob_title,
    runoob_author,
    submission_date
from
    @dataset
where
    runoob_id = #{runoob_id};  --runoob_id 自动为请求参数，可自动进行 请求参数推断。

编辑器语法说明：

常用转义字符

3.3 高级配置

• 数据缓存时间：用于设定服务查询对结果集的缓存时间。

  • 系统策略：默认600s 缓存时间。

  • 手动设置缓存时间，单位：秒。

  • 关闭缓存时间。

3.4 保存Query

数据集、参数等信息配置完成后，您可以点击右上角 保存 按钮，保存该Query：

点 保存 按钮，直接保存当前版本。
若当前线上有已发布的版本，直接修改会影响调用，您可以选择以下保存方式：

1. 另存为新的版本：将当前的修改另存为新版本保存，在弹窗中填写 新版本号 即可完成保存。

2. 另存为新的Query：将当前的修改另存为新Query保存，在弹窗中填写 Query基本信息 完成新建。

3. 或者在右侧 版本信息 内可将当前版本Query下线之后，再进行修改保存。

4 Query基本信息

点击界面右侧导航栏中的 基本信息，即可实现基本信息的修改，支持修改Query名称、负责人、QPS限流、SLA、PCT99、超时等Query基本信息，修改完成后，点击 保存基本信息 按钮，即可完成修改。

5 版本信息

点击界面右侧导航栏中的 版本信息，记录历史各Query版本：

• 版本：

  • 您可以点击历史版本号，编辑界面将会切换到历史版本。

  • 您也可以在Query编辑界面上方的导航栏中，选择历史版本号，点击进入编辑。

• 版本对比：您可以勾选两个版本号，点击右上角 对比 按钮，进行基本信息、参数等对比。

• 提交日期：您可以点击说明栏的 排序 按钮，根据日期先后进行排序。

• 操作栏：

  • 下线-线上：将线上已有的版本下线操作。

  • 发布-线上：将未发布的版本操作上线，会覆盖之前已发布的版本。

  • 详情：点击后跳转到详情界面，查看Query的通用信息、版本信息、HTTPS接口信息等详情。

  • 删除：允许删除未发布的版本。

6 SQL语法详情

点击界面右侧导航栏中的 SQL语法详情，详细了解语法详情。

6.1 SQL通用规则

1. 仅支持一条 SQL 语句，不支持多条 SQL 语句。

2. 仅支持 SELECT 语句，不支持非 SELECT 语句，如 UPDATE， DESCRIBE 等。

3. 数据集使用字符串 @dataset 进行占位。如select p_date from @dataset。或者使用数据集目录名和数据集名字占位。比如 select p_date from `dir_name`.`dataset_name`。

4. 不支持 SELECT * 语句，必须明确指出需要查询的列。

6.2 定义参数

1. SELECT 语句的返回结果字段必须和 API 定义的返回参数名字、类型、个数保持一致。如果返回字段是聚合函数或其他表达式，请对其重命名。

2. SQL 语法是 dynamic unified sql(暂不支持直接使用底层引擎SQL语法)。 使用 #{} 符号来引用请求参数。比如需要引用参数 date 则写作#{date}, #{} 符号会根据参数类型将参数拼接到查询的最终SQL中。

3. 也可以使用 ${} 符号引用参数， ${} 符号不会根据数据类型将参数拼接到最终的SQL中，而是将${}内的参数的值作为字符串直接拼接到SQL中。比如参数 app (类型是string, 值是video), 对于表达式 app_name=#{app} 生成的查询语句是 app_name='video', 对于表达式 app_name=${app} 生成的查询语句是 app_name=video。

6.3 函数列表

支持多种函数，例如日期函数date、adddate、datediff等，您可以在搜索框中输入函数关键字进行搜索。
更多函数列表，详见界面右侧导航栏 SQL语法详情。