DBAPI + YashanDB:高效数据接口开发的新神器!

大家好,这里是公众号 DBA学习之路,分享一些学习国产数据库路上的知识和经验。

社群交流

为了给大家提供一些技术交流的平台,目前已成立的技术交流群:

  • Oracle 数据库交流群
  • 国产数据库交流群
  • Linux 技术交流群
  • ChatGPT 4o 免费体验群

需要进群(均已超过 200 人,需要邀请)可以添加号主微信:Lucifer-0622,备注对应的群名即可。

本文来自群里小伙伴 巫山暮雨 的投稿,介绍了 DBAPI + YashanDB:快速构建数据 API 接口的教程,思路清晰,干货满满!

前言

在当今快速发展的技术世界中,数据库和 API 的结合已经成为现代应用程序开发的核心。随着数据驱动决策的日益重要,如何有效地管理和利用数据成为了开发者和数据科学家面临的重要挑战。今天,我将带您探索如何使用 dbapi 这个强大的工具链接 yashandb 数据库来构建高效、可扩展的数据处理系统。

DBAPI 概述

狭义上说,DBAPI 是一个面向数仓开发人员的低代码工具,只需在页面上编写 sql,并配置好参数,就可以自动生成 http 接口。它可以帮助程序员快速的开发后端数据接口,尤其适用于 BI 报表、数据可视化大屏的后端接口开发。

广义上说,DBAPI 是整个企业数据接口的管理中心,是企业对外提供数据服务的管理平台。它提供了数据接口的动态创建发布功能,对接口的统一管理,并提供了对客户端的管理能力,可以监控客户端对接口的调用、控制客户端对接口的权限。

项目开源地址:https://gitee.com/freakchicken/db-api[1]

YashanDB 概述

YashanDB 是由深圳计算科学研究院自主研发的新型数据库管理系统,它融合了原创的有界计算、近似计算、并行可扩展和跨模融合计算理论,能够满足金融、政企、能源等关键行业对高性能、高并发及高安全性的要求。YashanDB  的核心优势在于其卓越的性能、极致的性价比以及对主流数据库生态的全面兼容性。

项目官网:https://www.yashandb.com/[2]

安装 DBAPI

配置 jdk 环境

前置条件,项目依赖 java 环境,请在本地配置 jdk 1.8+ 版本,很基础,这里不做介绍,请自行在搜索教程

可以参考 YashanDB 官网 JVM 环境配置教程:安装YashanDB JDBC驱动[3]

下载 DBAPI

访问项目官网获取安装包,这里以 Windows 个人版为例进行安装演示:

下载个人版进行解压缩:

获取序列号

DBAPI 对个人版有一年免费试用,获取激活码需要先运行项目获取序列号。进入 bin 目录,并以 PowerShell 运行 dbapi.ps1:

运行完自动停止运行并在结尾处打印一串序列号,或者进入项目的 logs/dbapi-access.log,在结尾处查看序列号,请保存此序列号,下一步激活需要:

激活 DBAPI

激活教程请移步:https://www.51dbapi.com/v4.0.0/activate/[4]

访问 https://support.51dbapi.com/#/free(opens new window)[5] 申请个人版免费许可证(有效期一年,到期后可继续申请):

操作完成后会得到一串 license:

复制这串 license,进入项目 conf 文件夹,并修改 key.properties 的 license 值:

启动 DBAPI

再次进入 bin 目录,并以 PowerShell 运行 dbapi.ps1:

登录项目

启动完成后,浏览器访问 http://127.0.0.1:8052/

初始用户名密码:admin/admin,登录后页面长这样,还是很简洁的:

安装 YashanDB

数据库安装

安装教程请查看我之前的教程:

YashanDB 数据库安装部署
YashanDB一键安装脚本分享

创建测试表格以及数据

使用 YahsanDB 官方的客户端工具连接数据库并创建一张 T_USER 表,并插入几条数据:

DBAPI 集成 YashanDB

下载驱动包

想要 DBAPI 集成 YashanDB,首先需要获取 YashanDB 的 JDBC 驱动,可以从官网下载获取:

下载地址:https://download.yashandb.com/download[6]

将下载的驱动包 yashandb-jdbc-1.8.0.jar 手动放入 DBAPI 部署后的 lib 目录下:

然后重启一下 DBAPI 项目,重新登录 DBAPI 的 web 页面,本地部署则访问:http://127.0.0.1:8052/,使用初始账户密码 admin/admin 登录,进行 DBAPI 开发 YashanDB 数据库 API。

创建数据源

填写相关的参数数据。具体参看下方说明:

  • 数据库:选择others
  • JDBC驱动Class:com.yashandb.jdbc.Driver
  • JdbcUrl:jdbc:yasdb://10.10.10.2:1688/yasdb,改成你的数据库的IP地址以及端口
  • 用户名:即数据库用户名
  • 密码:即数据库用户对应的密码

点击测试会测试数据库连接是否正常:

然后保存数据源即可:

创建 API 分组

点击创建一个 API 分组并保存:

创建 API

在刚刚创建的 api 分组内新增 api,这里以查询用户信息为例,点击 + 号新增 api:

维护基本信息:

创建执行器:

数据源选择维护的 YashanDB 数据源,在 sql 执行器内填写查询语句,这里是查询全部用户信息,调试 sql 语句:

运行 sql 会将执行结果打印出来,没问题后再退出调试窗口,点击左上角最小化按钮:

编辑全局插件:

我这里面没有引用任何插件,不做填写,然后点击保存。

上线 API

点击刚刚创建的 API 右边的菜单,如图点击 ,上线 API:

调试 API

如图点击按钮,调试 API:

进入页面点击发送请求,进行调试 API:

对比数据,json 返回 6 条数据与数据库中一致,至此,集成完毕。

更多相关 DBAPI 的用法请自行探索。可参考文档:

DBAPI 使用文档:https://www.51dbapi.com/v4.0.0/guide/[7]

写在最后

如果有遗漏或者不足的地方,欢迎评论区补充或者投稿,感谢阅读!

往期精彩文章

达梦数据库安装最详细教程
一招教你学会达梦数据库的免密登录
一文讲透达梦数据库的大小写敏感
效率翻倍!达梦数据库 disql 使用技巧全攻略
达梦数据库参数配置与一键优化指南
达梦 AWR 报告快速上手指南
金仓数据库 KingbaseES V9 单机安装指南
KingbaseES KSQL 免密登录的几种方式
KingbaseES 控制文件冗余与恢复秘籍
南大通用 GBASE 8s V8.8 数据库最全安装指南
GBase 8a MPP 集群部署最佳实践
GBase 8s GDCA 认证课后练习题大全(题库)
GBase 8s 数据库巡检报告及一键巡检脚本
YashanDB 一键生成 AWR 报告
YashanDB 数据库安装部署

「喜欢这篇文章,您的关注和赞赏是给作者最好的鼓励」
参考资料
[1]

https://gitee.com/freakchicken/db-api: https://gitee.com/freakchicken/db-api

[2]

https://www.yashandb.com/: https://www.yashandb.com/

[3]

安装YashanDB JDBC驱动: https://doc.yashandb.com/yashandb/23.3/zh/%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C/JDBC%E9%A9%B1%E5%8A%A8/%E5%AE%89%E8%A3%85YashanDB%20JDBC%E9%A9%B1%E5%8A%A8.html#jvm%E7%8E%AF%E5%A2%83%E5%AE%89%E8%A3%85

[4]

https://www.51dbapi.com/v4.0.0/activate/: https://www.51dbapi.com/v4.0.0/activate/

[5]

https://support.51dbapi.com/#/free(opens new window): https://support.51dbapi.com/#/free

[6]

https://download.yashandb.com/download: https://download.yashandb.com/download

[7]

https://www.51dbapi.com/v4.0.0/guide/: https://www.51dbapi.com/v4.0.0/guide/

请使用浏览器的分享功能分享到微信等