文档

集成数据库

更新时间:

魔笔平台提供了强大的数据库集成功能,允许用户通过简单的配置,实现对 MySQL 数据库的便捷连接和数据操作。本文档将指导您如何创建和使用数据库集成。

功能介绍

魔笔平台的数据库集成功能支持以下特点:

  • 动态 SQL 支持:在 SQL 语句中支持使用 JavaScript 表达式,为动态查询提供便利。

  • 自定义触发方式:集成操作可以设置为手动触发或自动运行,满足不同的业务场景需求。

  • 回调和数据转换:支持在查询成功或失败时执行特定的集成操作事件,以及对返回的数据进行自定义处理。

  • 高级设置:提供防抖和禁止执行条件的高级配置,以优化集成操作的执行。

事件相关内容可参考:集成操作事件

创建数据库集成

1. 创建数据库集成

  1. 登录魔笔平台,进入管控台。

  2. 导航至“资源”->“集成”,点击“创建集成”。

  3. 选择“数据库类型的集成”(当前支持 MySQL),并填写集成名称及描述。

  4. 配置不同环境的数据库连接信息,包括hostport、数据库名称、用户名和密码。

  5. 若账号下已有阿里云 RDS MySQL 数据库,可选择“从当前云账号录入”,快捷选择已有的数据库资源。

image

  1. 点击“确定”以创建数据库集成。

2. 在应用内部创建集成操作

  1. 打开“代码”面板,点击对应作用域的“+”后选中“集成操作”。

    image

  2. 选择之前创建的数据库集成作为资源,输入 SQL 查询语句后,根据需求,选择集成操作的触发方式。

image

  1. 点击“运行”预览查询效果。

配置面板详解

通用配置

  • 参数:定义查询所需的参数,包括类型、默认值和描述。在查询语句中,可通过{{ varName }}的方式引用参数。

  • SQL 语句:编写发送到数据库的 SQL 语句。在语句中,可使用{{}}来编写 JS 表达式,例如SELECT * FROM test WHERE name={{input.value}}。注意,对于可能引起 SQL 注入的部分(如表名),使用{{}}可能导致执行失败。

  • 触发方式:选择手动触发或自动运行。手动触发仅在触发集成操作事件或通过 API 调用action.trigger方法时执行。自动运行则在初次加载和依赖项变更时自动执行,例如当{{input1.value}}改变时。

  • 超时时间:配置操作的最大执行时间。

  • 描述:为集成操作提供详细描述。

回调配置

  • 数据转化:对接口返回的数据进行处理,默认为return data,即不进行处理。

  • 成功回调:配置接口调用成功时触发的事件。

  • 失败回调:配置接口调用失败时触发的事件。

高级配置

  • 防抖:设置防抖表达式,避免接口的频繁调用。

  • 禁止执行条件:根据条件表达式确定是否执行此集成操作。

手动触发数据库集成

事件触发

  1. 在需要触发集成操作的组件中,配置事件处理器。

  2. 将动作类型设置为集成操作,并选择相应的集成。

  3. 以对象形式填写已配置的参数。

API 触发

若此集成操作的名称为action1,则在任何可以执行脚本的地方,可以使用action.trigger()方法触发集成操作,若集成操作配置了参数,则需要以对象形式填写已配置的参数。