Records适配GaussDB开源开发任务
1 背景介绍
开源for Huawei(参考:https://developer.huaweicloud.com/programs/opensource/contributing/)通过和公司、高校、社区的开发者合作,完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发,帮助繁荣Huawei的基础生态,同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前,开发者可以下载 开源for Huawei Wiki(参考:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview) 了解详细的开发步骤,技术准备,以及开发过程需要的各种资源。
2 需求分析
2.1 项目影响力
Records 是一个 Python 的第三方开源库,它提供了一个简单而强大的接口来执行原生 SQL 查询,并处理查询结果。
功能介绍:
• 原生 SQL 查询:records 允许你直接执行原生 SQL 语句,这提供了对数据库操作的完全控制。
• 参数化查询:为了防止 SQL 注入,records 支持参数化查询。
• 自动转换结果:查询结果会自动转换为 Python 对象,使得数据处理更加方便。
• 支持多种数据库:records 支持多种数据库后端,包括 MySQL、PostgreSQL、SQLite 等。
• 事务支持:records 支持事务操作,可以确保数据的一致性。
• 批量操作:records 支持批量插入和更新操作,提高了数据操作的效率。
• 结果集处理:查询结果可以以多种方式处理,例如直接返回列表、生成 CSV 文件、导出为 JSON 等。
• 模型定义:你可以定义模型来表示数据库表,这些模型可以继承自 records 的 Record 类。
• 关联查询:records 支持定义模型之间的关系,如一对一、一对多等。
• 灵活的配置:records 允许你自定义数据库连接参数,以及查询时的各种选项。
• 数据迁移支持:records 可以帮助你管理数据库迁移,使得数据库结构的变更更加容易。
• 丰富的文档和社区支持:records 提供了详细的文档和活跃的社区支持,帮助开发者解决问题。
用户使用情况:
用户使用 records 的情况非常广泛,从社区的讨论来看,records 在开源社区中非常受欢迎。它被用于各种项目中,尤其是那些需要快速进行数据库操作的场景。用户普遍认为 records 的 API 设计简洁直观,易于使用,同时提供了强大的功能,如参数化查询、批量操作、事务支持、数据导出等 。
此外,records 还提供了命令行工具,使得在终端中执行 SQL 查询变得更加方便。用户可以通过简单的命令行调用来执行查询,并将结果导出为多种格式,如 JSON、TSV、XLS 等 。
总的来说,records 库的用户使用情况良好,它因其简单性、易用性和强大的功能而受到开发者的欢迎。
商业价值:
• 提高开发效率:records 允许开发者使用简洁的 Python 代码来执行 SQL 查询,这可以显著提高开发效率,减少编写和维护数据库代码的时间 。
• 降低技术门槛:即使不是数据库专家,开发者也可以使用 records 轻松地与数据库进行交互,这降低了使用数据库的技术门槛 。
• 支持多种数据库:records 支持多种数据库后端,包括 MySQL、PostgreSQL、SQLite 等,这使得它能够在多种商业环境中使用 。
• 数据导出功能:records 可以方便地将查询结果导出为 CSV、XLS、JSON、HTML 表格、YAML 或 Pandas DataFrames 等多种格式,这对于数据报告和分析非常有价值 。
• 事务支持:records 支持数据库事务,这对于需要保证数据一致性的商业应用来说是一个重要的特性 。
• 批量操作:records 提供了批量插入和更新数据的功能,这对于处理大量数据的商业应用来说可以提高效率 。
• 开源和可定制:records 是一个开源库,可以根据特定的业务需求进行定制和扩展 。
• 社区支持:records 有一个活跃的社区,开发者可以在社区中获得帮助和支持,这对于解决开发中遇到的问题非常有帮助 。
• 适用于多种应用场景:无论是小型应用还是大型企业级应用,records 都能够提供有效的数据库操作解决方案 。
所属社区:
Records 的主要作者是 Kenneth Reitz,他是知名的开源社区成员,参与了多个流行的Python项目。该库的所有权和维护通常在GitHub上,由Kenneth和其他贡献者共同管理。
源代码地址:https://github.com/kennethreitz/records/tree/master
官网主页:https://pypi.org/project/records/
主要开发语言:Python
项目数据:Fork 572, Star 7.2K, Contributor 47,最近一次提交:2024-07-09 star历史(https://star-history.com/):
2.2 任务目的和范围
本任务的主要目的是让Records社区支持GaussDB数据库,帮助拓展GaussDB的影响力,也方便GaussDB的用户能够将数据库由MySQL换成GaussDB。同时,该任务可以为一些项目迁移打下基础,方便用户在使用Records的时候,可以选择GaussDB作为数据存储DB。
能力要求
完成该任务需要具备微服务开发经验,熟悉Records的使用方法和底层逻辑。开发过程中主要使用Python语言,演示DEMO会涉及少量的Vue、TypeScirpt前端知识。
适配任务清单
生态 |
生态细类 |
是否需要验证 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
昇腾生态 |
指令 |
否 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
CANN |
否 |
应用功能依赖于CANN运行。 |
否 |
使用CANN实现适配逻辑。 |
|
MindSpore |
否 |
应用功能依赖于MindSpore运行。 |
否 |
使用MindSpore实现适配逻辑。 |
|
鲲鹏生态 |
指令 |
是 |
使用鲲鹏处理器运行应用。 |
否 |
使用鲲鹏指令实现适配逻辑。 |
Euler |
是 |
使用Euler系统运行应用。 |
否 |
使用Euler系统调用实现适配逻辑。 |
|
数据库生态 |
GaussDB |
是 |
使用GaussDB功能。 |
是 |
使用GaussDB的驱动和SQL实现适配逻辑。 |
GaussDB(DWS) |
否 |
使用GaussDB(DWS)功能。 |
否 |
使用GaussDB(DWS)的驱动和SQL实现适配逻辑。 |
|
存储生态 |
OBS |
否 |
使用OBS功能。 |
否 |
基于OBS API访问实现适配逻辑。 |
鸿蒙生态 |
HarmonyOS |
否 |
使用HarmonyOS系统运行应用。 |
否 |
使用HarmonyOS系统调用实现适配逻辑。 |
3 工作量评估和任务分解
3.1 工作量评估
任务 |
人/天 |
完成GaussDB数据库适配功能开发 |
2 |
完成DEMO设计和代码开发 |
2 |
基于CCE容器完成环境搭建和DEMO部署、验证 |
2 |
输出开发资料和博客 |
1 |
代码推送上游社区和更新社区资料 |
2 |
总计 |
9人天 |
3.2 完成GaussDB数据库适配功能开发
• Records的数据库驱动引擎依赖的是SQLAlchemy的数据库驱动引擎,因此需要使SQLAlchemy兼容GaussDB的数据库,但可能需要对其进行扩展或定制以支持GaussDB特有的功能。
• 在写SQL语句时,需要兼容GaussDB的SQL语法,包括对返回结果的处理,如果GaussDB有特定的SQL语法或函数,应该在对返回结果处理时实现这些特性。
• 默认不支持分布式数据库。这可能需要开发中间件或自定义数据库路由来处理数据分片和查询路由。
3.3 完成GaussDB演示DEMO设计
参考下面的用例图:
Records使用SQLAlchemy的数据库引擎,SQLAlchemy使用DB API来实现数据库的访问,重点关注原生SQL的支持性,包括如果返回结果有特殊性的处理。
DEMO在resource-server-python(使用了Django,开发者需要在里面集成Records实现数据库访问)中完成, https://pypi.org/project/records/的例子开发任务,通过RESTful API暴露数据库访问能力供前端使用。
3.4 DEMO开发、部署和验证
DEMO的简单部署图如下:
根据DEMO设计,完成演示功能开发和部署。要求使用CCE容器(Euler镜像)进行部署。
为了简化用户开发,提供了一个项目脚手架。开发者可以在脚手架基础上,完成DEMO功能开发。可以参考: https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/blob/main/README.md 提供的指导,可以帮助您在华为云开通资源、编译DEMO和基于DEMO做增量代码开发。
3.5 在华为云开发者论坛输出博客
访问华为云开发者论坛(参考:https://bbs.huaweicloud.com/blogs)发表博客,介绍完成这些任务的过程和心得。内容包括不限于如下内容:
·开源for Huawei的背景
·开源软件的功能介绍
·开发适配过程及碰到和解决的问题
·DEMO设计、开发、部署过程
·代码推送开源社区及互动过程
博客打上如下标签:
·开源(必选)
·开发者(必选)
·GaussDB数据库(可选)
·云数据库 GaussDB(可选)
· 鲲鹏(可选)
·昇腾(可选)
·鸿蒙(可选)
·对象存储 OBS(可选)
3.6 代码推送上游社区
将代码合并到Records官网主干代码;更新Records官网资料,包括版本说明、开发指南等。
4 验收材料
验收细则 |
评分说明 |
是否为验收必选项 |
结果(通过/不通过) |
开发者举证 |
功能开发:完成与华为三大根技术生态(鲲鹏云、昇腾云、鸿蒙)适配的功能开发 |
完成GaussDB数据库适配功能开发。举证提供PR链接。 |
是 |
||
代码质量:适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
是 |
||
提供相关文档,比如部署文档、使用文档、配置文档等 |
根据社区要求,完善相关的开发指南和部署指导 |
否 |
||
合入到开源项目主仓:代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
是 |
||
Deomo设计&开发:完成功能演示Demo的开发 |
举证提供DEMO仓库地址和DEMO开发提交记录。 |
是 |
||
Demo部署&验证:完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
||
发布博客:发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
||
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
||
单机版镜像上架时支持模板部署。 |
否 |
|||
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
||
集群版镜像上架时支持模板部署 |
否 |
5 参考资料
1. 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
- 点赞
- 收藏
- 关注作者
评论(0)