数据库查询插件
1. 简介
1.1 插件简介
该插件支持在表单输入编号、名称等数据时,查询数据库单表/多表或者视图的单条/多条数据并回填至当前表单对应的字段中。且支持写 SQL 语句进行查询。
1.2 应用场景
常用于主数据回填、业务数据查询等场景。如人员、产品、价格等数据查询与回填;合同、订单、费用报销等数据查询。
1.3 预期效果
开启数据库查询插件,在「数据库查询」表单中输入订单编号后,即可查询并回填订单相关信息至对应字段中。
1.4 使用说明
数据库查询为付费插件,请联系我们进行增购。插件购买流程如下所示:
注:插件购买期限需要和简道云版本期限保持一致。
2. 插件安装及配置
2.1 安装插件
1)直接安装
2)插件市场处安装
在简道云「插件市场」处,安装「数据库查询」插件。插件市场处安装方法可参见文档:插件市场中【2.3 插件安装】。
2.2 配置插件
安装后,在「插件管理」处,点击插件右侧的「设置」按钮,根据企业数据库信息,将「数据库类型」、「主机地址」、「端口号」、「数据库账号」、「数据库密码」、「数据库名称」等信息配置进去,配置完成后点击确定。
2.3 启用插件
在插件管理中,打开「数据库查询」插件右侧开关,启用插件。
3. 表单搭建
插件使用体验可先安装:数据库查询插件模板表单。本文将按照示例表单进行讲解。
1)新建「数据库查询」表单,字段设置如下所示:
字段名称 | 字段类型 |
订单编号 | 单行文本 |
客户名称 | |
客户ID | |
产品明细 | 子表单 |
产品名称 | 子字段-单行文本 |
产品编码 | |
单位 | |
单价 | 子字段-数字 |
销售数量 | |
销售金额 | |
销售总金额 | 数字 |
备注 | 单行文本 |
收货联系人 | |
收货联系电话 | |
收货地址 | |
创建时间 | 日期时间 |
创建人员 | 单行文本 |
创建部门 |
2)由于订单相关信息,为查询数据库后自动回填,故订单相关信息中的字段是不可编辑的,应取消订单相关信息字段的可编辑权限。以取消「客户名称」的可编辑权限为例,设置方法如下:
点击「客户名称」,在「字段属性 >> 字段权限」处,取消勾选「可编辑」权限。
注:其他回填字段的设置,与「客户名称」字段设置相同。
4. 前端事件配置
4.1 添加前端事件
进入「表单属性」,点击前端事件下的设置,添加前端事件:
4.2 设置事件名称和说明
添加好前端事件后,首先设置前端事件的基础信息,即事件名称和事件说明,用于区分前端事件:
4.3 设置触发动作
设置触发动作:触发字段选择「订单编号」字段。
4.4 设置执行动作
该插件支持以下四种查询方式,企业可根据自己实际业务情况按需配置即可。
- SQL 查询单条数据:写 SQL 语句查询数据库单条数据,仅返回 1 条数据;可以返回到主表,也可以返回子表;
- SQL 查询多条数据:写 SQL 语句查询数据库多条数据,仅返回多条数据;只能返回到子表;
- 参数查询单条数据:参数配置查询数据库单条数据,仅返回 1 条数据;可以返回到主表,也可以返回子表;
- 参数查询多条数据:参数配置查询数据库多条数据,仅返回多条数据;只能返回到子表;
4.4.1 SQL单条数据查询
- 选择插件:选择「数据库查询」插件,选择「SQL 查询单条数据」事件;
- 以「组合」方式设置查询语句:
- 查询单表:select 字段名1,字段名2 from 表名 where 字段名='表单字段值';
- 查询多表:select 表名1.字段名,表名2.字段名, from 表名1,表名2 where 表名1.字段名=表名2.字段名 and 表名1.字段名='表单字段值';
4.4.2 SQL多条数据查询
- 选择插件:选择「数据库查询」插件,选择「SQL 查询多条数据」;
- 以「组合」方式设置查询语句:
- 查询单表:select 字段名1,字段名2 from 表名 where 字段名="表单字段值";
- 查询多表:select 表名1.字段名,表名2.字段名, from 表名1,表名2 where 表名1.字段名=表名2.字段名 and 表名1.字段名="表单字段值";
4.4.3 参数单条数据查询
- 选择插件:选择「数据库查询」插件,选择「参数查询单条数据」;
- 输入数据库/视图名称:表名1,表名2,表单3,....../视图名
- 设置多表关系:表名1.字段名=表名2.字段名,表名1.字段名=表名3.字段名,
- 设置查询字段:表名1.字段名1,表名1.字段名2,表名2.字段名3,表名2.字段名4,......
- 设置查询条件:表名1.字段名1="值1",表名2.字段名2="值2"
4.4.4 参数多条数据查询
- 选择插件:选择「数据库查询」插件,选择「参数查询多条数据」;
- 输入数据库/视图名称:表名1,表名2,表单3,......
- 设置多表关系:表名1.字段名=表名2.字段名,表名1.字段名=表名3.字段名,
- 设置查询字段:表名1.字段名1,表名1.字段名2,表名2.字段名3,表名2.字段名4,......
- 设置查询条件:表名1.字段名1="值1",表名2.字段名2="值2"
注:
1)单表/多表:查询单表时,字段名前可以不加表名,查询多表时字段名前必须加表名;多个表之间用英文逗号隔开;
2)查询字段:多个字段用英文逗号隔开(条件字段可以不在查询字段中);
3)查询条件:可以 1 个或者多个条件;条件关系 and、or、in、like 等都可以;多表查询时需要设置多表连接条件;多个条件之间用英文逗号隔开;表单值需要增加英文状态下的单引号。
4.5 设置回填字段
根据查询字段的顺序,依次返回参数1、参数2、参数3、参数4、......
根据所需要的信息,添加参数,并按顺序设置如下所示的存储关系,设置完成点击「保存」。
4.6 效果演示
效果参见本文【1.3 预期效果】。
5. 注意事项
5.1 子表数据说明
目前可支持查询数据库多个关联子表,在查询条件中设置好多个表之间的连接条件即可;
当返回数据需分别返回到主表和子表单时,可设置多个前端事件,此时主表为查询单条数据,子表为查询多条数据。
5.2 数据库说明
1)目前仅支持 mysql / sqlserver / postgresql 数据库。如希望增加更多数据库,可通过下方联系方式联系开发者增加。
注:postgresql 数据库,默认端口号为 5432,其它配置保持不变。
2)本地部署的数据库如具备允许公网访问的固定 IP,则可使用此插件;暂不支持公网访问的本地数据库。如您的数据库 IP 属于如下所示的局域网 IP 地址,则不支持访问:
- 10.0.0.0 - 10.255.255.255
- 172.16.0.0 - 172.31.255.255
- 192.168.0.0 -192.168.255.255
5.3 字段数量说明
目前支持查询并回填 30 个字段信息,若有更多字段的需求,可通过下方联系方式联系开发者增加字段数量。
5.4 数据回填说明
当查询单条数据时,即时查询条件对应有多条数据,也是返回1条数据,若需查询多条数据,需使用查询多条数据。
通常查询单条数据,适用于通过唯一的数据编号查询1条数据,查询多条数据主要适用于查询子表数据;
5.5 IP地址白名单
如果您的数据库允许外放访问但需要 IP 地址加白名单,请设置白名单 IP 为: 47.97.99.12。
6. 联系方式
该插件为官方合作的服务商开发,若您在使用过程中有任何疑问,可通过以下方式咨询:
- 公司:成都轻如燕企业服务有限公司
- 联系人:赵鹏
- 联系电话:18583980516(微信同号)