快速将数据库SQL转换为RESTful API
off999 2025-04-09 19:00 15 浏览 0 评论
企业内部经常会开发一些小型系统或需要将现有的系统开发Restful API供内部系统集成,这类系统的特点是:几乎都是CRUD操作,业务简单,使用人数少,生命周期短。有没有一种工具,我们只需要关注数据库设计,使用它快速自动生成Restful API供前端或第三方系统调用?
本文将为大家介绍一个工具Hasura,它能够帮助你通过实时GraphQL API即时访问你的数据,因此你可以更快地构建和发布现代应用程序和API。Hasura连接到你的数据库、REST 服务器、GraphQL服务器和第三方API,为你的所有数据源提供统一的实时GraphQL API。
什么是Hasura
开源的SQL转API的项目不少,例如SQLer和Directus是Github Star数量较高的项目。Directus提供了用于管理SQL数据库内容的实时API和应用仪表板;SQLer是一个小型便携式服务器,使你可以使用SQL查询编写API,以便在任何人点击它时执行,它还使你能够定义验证规则,以便你可以验证请求正文/查询参数,以及使用简单的数据转换JavaScript语法。SQLer使用Nginx风格的配置语言(HCL)和JavaScript引擎来自定义表达式。
相比SQLer、Directus,Hasura提供了更为灵活、易用、强大的功能,同时它提供了Web Console,更便于管理API。Hasura提供以下功能:
- 强大的查询:内置过滤、分页、模式搜索、批量插入、更新、删除;
- 添加现有的数据库:将其指向现有数据库以立即获得即用型GraphQL API;
- 实时查询:使用订阅将任何GraphQL查询转换为实时查询;
- 操作扩展:编写REST API以使用自定义业务逻辑扩展Hasura的架构。
- 触发webhooks或无服务器功能:在Postgres插入/更新/删除事件;
- 预定触发器:使用cron配置或一次性事件在特定时间点执行自定义业务逻辑;
- 细粒度访问控制:与身份验证系统集成的动态访问控制;
- 管理UI:提供一个易用的Web管理UI;
- 多数据库支持:PostgreSQL、SQL Server、Big Query、MySQL等;
Hasura与GraphQL
GraphQL是一种数据语言,此语言的开发目的是便于应用程序从服务器上提取数据。它具有可指定的自记录风格。在GraphQL操作中,客户端指定数据从服务器返回时的结构如何。这样客户端就可以只查询它需要的数据,以它需要的格式进行查询。
GraphQL的实现分为Client和Server,Server实现了GraphQL协议,支持GraphQL查询,Client是一个GraphQL请求客户端,就像jQuery Ajax和Restful后端API的关系一样。GraphQL 有三项顶级操作:
- 查询 - 只读提取;
- 更改 - 写入,然后提取;
- 订阅 - 用于接收数据的长期活动连接;
GraphQL使应用程序开发人员可以轻松地从他们的API中精确查询他们想要的数据。例如,假设我们正在构建一个送餐应用程序。以下是Postgres上的表结构可能的样子:
对于显示当前用户订单的“订单状态”的应用程序,GraphQL查询将获取最新的订单状态和交付订单的位置,此查询参数作为字符串发送到网络服务器,该服务器对其进行解析、应用授权规则并适当调用数据库等内容以获取应用程序的数据。它以请求的确切格式将此数据作为JSON返回。
实时查询是能够订阅特定查询的最新结果。随着底层数据的变化,服务器应该将最新的结果推送给客户端。这与GraphQL完美契合,因为GraphQL客户端支持订阅来处理混乱的WebSocket连接。如果GraphQL服务器支持,将查询转换为实时查询非常简单。
Hasura本质上是一个GraphQL引擎,它也提供将GraphQL查询转换为Resrful API的功能。它拥有良好的并发实时订阅性能,并且支持垂直和/或水平扩展:
Hasura GraphQL引擎订阅实际上是实时查询,即订阅将返回正在进行的查询的最新结果,而不是导致结果的单个事件。Hasura通过将多个相似的订阅组合成一个SQL查询并从数据库中获取单个响应来优化订阅,而不是为每个订阅进行单独的SQL查询。
快速开始
下面我们开始使用Docker + Hasura + PostgreSQL演示一个CRUD的例子,具体看看Hasura能够提供的功能。首先我们使用Docker启动PostgreSQL数据库和Hasura Engine,并开启Console:
# PostgreSQL
docker run --name local-postgres \
-e POSTGRES_PASSWORD=your_password \
-e PGDATA=/var/lib/postgresql/data/pgdata \
-p 5432:5432 -d postgres:12
# Hasura
docker run -d -p 8080:8080 \
-e HASURA_GRAPHQL_DATABASE_URL=postgres://username:password@hostname:port/dbname \
-e HASURA_GRAPHQL_ENABLE_CONSOLE=true \
hasura/graphql-engine:latest
笔者使用Mac Book运行本案例,使用的docker.for.mac.localhost连接数据库,这是Docker内置的变量,代表本地hostname。如果你在实验过程中遇到PostgreSQL连接的问题,在Docker应用中连接Docker数据库可以通过inspect命令查看数据库在Docker中的端口和IP。
启动之后访问localhost:8080就可以看到Hasura的Console界面。这里我们直接使用这台PostgreSQL数据库,不再连接另外的Database。
安装PostgreSQL命令行客户端:
brew install libpq
brew link --force libpq
psql postgres://postgres:[your password]@localhost:5432/postgres
在PostgreSQL中创建一个Schema和两张表,一张是用户表,另一张是薪水表:
create schema if not exists example;
set search_path to 'example';
create sequence users_id_seq start 1000 increment 1;
create table users (
id integer primary key default nextval('users_id_seq'),
name varchar(40) NOT NULL,
gender integer NOT NULL,
cell_phone varchar(40) not null
);
create sequence payroll_id_seq start 1000 increment 1;
create table payroll (
id integer primary key default nextval('payroll_id_seq'),
user_id integer not null,
pay_day date not null,
salary money not null
);
在Console中添加这两张表:
插入一条用户数据:
mutation MyMutation($object: example_users_insert_input!) {
insert_example_users_one(object: $object) {
cell_phone
gender
name
}
}
// 参数
{
"object": {
"cell_phone": "18200008888",
"gender": 1,
"name": "Lisa"
}
}
查询数据库发现数据已经插入:
postgres=# select * from users;
id | name | gender | cell_phone
------+------+--------+-------------
1001 | Lisa | 1 | 18200008888
(1 row)
点击上图中的REST按钮将插入操作转换为Restful接口:
接着创建用户查询接口,在API Query窗口中添加User查询,生成的查询语句如下:
query MyQuery {
example_users {
cell_phone
gender
id
name
}
}
你同样可以点击“Analye”按钮查看Hasura生成的SQL语句:
点击REST按钮创建Restful API,至此我们创建了2个API:
通过浏览器访问API,效果如下:
删除、修改与订阅功能下文就不再演示了,你可以根据官方文档解锁Hasura更多的功能。通过本文的案例,相信你可以初步了解Hasura提供的能力,它是一个Graphql引擎,并能提供Restful接口,同时它能定时执行你定义的SQL,并在数据操作前允许你回调自定义接口以扩展功能。
通过向大家介绍Hasura为大家解决工作中的问题提供一个工具储备,相信能对你有所帮助。如果你在工作中也用到了Hasura,欢迎留言讨论。
参考资料
https://github.com/hasura/graphql-engine
https://hasura.io/docs/latest/graphql/core/index.html
相关推荐
- python入门到脱坑经典案例—清空列表
-
在Python中,清空列表是一个基础但重要的操作。clear()方法是最直接的方式,但还有其他方法也可以实现相同效果。以下是详细说明:1.使用clear()方法(Python3.3+推荐)...
- python中元组,列表,字典,集合删除项目方式的归纳
-
九三,君子终日乾乾,夕惕若,厉无咎。在使用python过程中会经常遇到这四种集合数据类型,今天就对这四种集合数据类型中删除项目的操作做个总结性的归纳。列表(List)是一种有序和可更改的集合。允许重复...
- Linux 下海量文件删除方法效率对比,最慢的竟然是 rm
-
Linux下海量文件删除方法效率对比,本次参赛选手一共6位,分别是:rm、find、findwithdelete、rsync、Python、Perl.首先建立50万个文件$testfor...
- 数据结构与算法——链式存储(链表)的插入及删除,
-
持续分享嵌入式技术,操作系统,算法,c语言/python等,欢迎小友关注支持上篇文章我们讲述了链表的基本概念及一些查找遍历的方法,本篇我们主要将一下链表的插入删除操作,以及采用堆栈方式如何创建链表。链...
- Python自动化:openpyxl写入数据,插入删除行列等基础操作
-
importopenpyxlwb=openpyxl.load_workbook("example1.xlsx")sh=wb['Sheet1']写入数据#...
- 在Linux下软件的安装与卸载(linux里的程序的安装与卸载命令)
-
通过apt安装/协助软件apt是AdvancedPackagingTool,是Linux下的一款安装包管理工具可以在终端中方便的安装/卸载/更新软件包命令使用格式:安装软件:sudoapt...
- Python 批量卸载关联包 pip-autoremove
-
pip工具在安装扩展包的时候会自动安装依赖的关联包,但是卸载时只删除单个包,无法卸载关联的包。pip-autoremove就是为了解决卸载关联包的问题。安装方法通过下面的命令安装:pipinsta...
- 用Python在Word文档中插入和删除文本框
-
在当今自动化办公需求日益增长的背景下,通过编程手段动态管理Word文档中的文本框元素已成为提升工作效率的关键技术路径。文本框作为文档排版中灵活的内容容器,既能承载多模态信息(如文字、图像),又可实现独...
- Python 从列表中删除值的多种实用方法详解
-
#Python从列表中删除值的多种实用方法详解在Python编程中,列表(List)是一种常用的数据结构,具有动态可变的特性。当我们需要从列表中删除元素时,根据不同的场景(如按值删除、按索引删除、...
- Python 中的前缀删除操作全指南(python删除前导0)
-
1.字符串前缀删除1.1使用内置方法Python提供了几种内置方法来处理字符串前缀的删除:#1.使用removeprefix()方法(Python3.9+)text="...
- 每天学点Python知识:如何删除空白
-
在Python中,删除空白可以分为几种不同的情况,常见的是针对字符串或列表中空白字符的处理。一、删除字符串中的空白1.删除字符串两端的空白(空格、\t、\n等)使用.strip()方法:s...
- Linux系统自带Python2&yum的卸载及重装
-
写在前面事情的起因是我昨天在测试Linux安装Python3的shell脚本时,需要卸载Python3重新安装一遍。但是通过如下命令卸载python3时,少写了个3,不小心将系统自带的python2也...
- 如何使用Python将多个excel文件数据快速汇总?
-
在数据分析和处理的过程中,Excel文件是我们经常会遇到的数据格式之一。本文将通过一个具体的示例,展示如何使用Python和Pandas库来读取、合并和处理多个Excel文件的数据,并最终生成一个包含...
- 【第三弹】用Python实现Excel的vlookup功能
-
今天继续用pandas实现Excel的vlookup功能,假设我们的2个表长成这样:我们希望把Sheet2的部门匹在Sheet1的最后一列。话不多说,先上代码:importpandasaspd...
- python中pandas读取excel单列及连续多列数据
-
案例:想获取test.xls中C列、H列以后(当H列后列数未知时)的所有数据。importpandasaspdfile_name=r'D:\test.xls'#表格绝对...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python自定义函数 (53)
- python进度条 (67)
- python吧 (67)
- python字典遍历 (54)
- python的for循环 (65)
- python格式化字符串 (61)
- python串口编程 (60)
- python读取文件夹下所有文件 (59)
- java调用python脚本 (56)
- python操作mysql数据库 (66)
- python字典增加键值对 (53)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python人脸识别 (54)
- python多态 (60)
- python命令行参数 (53)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)