SQLAlchemy适配GaussDB开源开发任务

举报
yangjiaxin98 发表于 2024/10/28 16:15:35 2024/10/28
【摘要】 SQLAlchemy是为Python编程语言提供的开源SQL工具包及对象关系映射器(ORM)。本任务主要为了让SQLAlchemy社区支持GaussDB数据库,帮助拓展GaussDB的影响力,也方便SQLAlchemy的用户能够将数据库由MySQL换成GaussDB。

1 背景介绍

开源for Huawei(参考:https://developer.huaweicloud.com/programs/opensource/contributing/)通过和公司、高校、社区的开发者合作,完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发,帮助繁荣Huawei的基础生态,同时让开源软件能够更加简单、高效的运行于华为云上。

开始之前,开发者可以下载 开源for Huawei Wiki(参考:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview) 了解详细的开发步骤,技术准备,以及开发过程需要的各种资源。

需求分析

2.1 项目影响力

1. SQLAlchemy是为Python编程语言提供的开源SQL工具包及对象关系映射器ORM)。

以下是关于 SQLAlchemy 的详细介绍:

· 主要功能

o ORM(对象关系映射)通过将数据库表映射为Python类,开发者可以使用面向对象的方式操作数据库,而不必直接编写SQL语句

o 核心SQL表达语言除了ORMSQLAlchemy还提供了强大的SQL表达语言,允许开发者编写底层SQL查询,确保复杂查询的性能和灵活性

o SQL构造器:提供了一个强大的 SQL 表达式构造器,用于构建 SQL 查询

o 数据库抽象层通过对不同数据库的统一抽象,开发人员可以编写与特定数据库无关的代码,增强代码的可移植性

o 会话管理SQLAlchemy提供了一个会话管理系统,简化了数据库连接的生命周期管理

o 数据迁移和版本控制:与Alembic等工具的集成,支持数据库模式的迁移和版本控制,使得在项目演进中能够安全地更新数据库结构

· 所属社区SQLAlchemy官方团队,主要由创始人兼主要维护者Michael Bayer所领导

· 源代码地址https://github.com/sqlalchemy/sqlalchemy

· 官网主页https://www.sqlalchemy.org/

· 主要开发语言Python

· 用户使用情况SQLAlchemy在许多企业级项目中广泛应用,包括一些大型科技公司、初创企业、数据驱动型公司等,也广泛用于大型、科研机构的项目中。

· 主要商业价值

o 降低开发成本通过简化数据库操作和复杂查询,SQLAlchemy大篇幅减少了开发人员编写SQL的时间,降低了项目的开发和维护成本

o 提高代码质量ORM层提供了类型安全和语法检查,减少了人为编写SQL的错误,提升了代码的可靠性和安全性

o 支持业务扩展SQLAlchemy的灵活性允许企业在业务增长时快速调整和扩展数据库方案,而无需大幅度修改现有代码,提供了良好的可扩展性

o 跨数据库兼容性对多种数据库的支持,使得企业可以根据需要在不同数据库之前迁移,保证了商业策略调整的灵活性

2. 项目数据:Fork 1.4K, Star 9.4K, Contributor 631,最近一次提交:2024-09-10star历史如下https://star-history.com/):

2.2 任务目的和范围

任务的主要目的

为了SQLAlchemy社区支持GaussDB数据库,帮助拓展GaussDB的影响力,也方便SQLAlchemy的用户能够将数据库由MySQL换成GaussDB。同时,该任务可以为一些项目迁移打下基础,方便用户使用SQLAlchemy,可以选择GaussDB作为数据库后端

能力要求

完成该任务需要具备微服务开发经验,熟悉SQLAlchemy底层相关架构。开发过程中主要使用Python语言,演示DEMO会涉及少量的VueTypeScirpt前端(可选)。

适配任务清单

生态

生态细类

是否需要验证

验证逻辑说明

是否需要适配

适配场景说明

昇腾生态

指令

使用昇腾处理器运行应用。

使用昇腾指令实现适配逻辑。

CANN

应用功能依赖于CANN运行。

使用CANN实现适配逻辑。

MindSpore

应用功能依赖于MindSpore运行。

使用MindSpore实现适配逻辑。

鲲鹏生态

指令

使用鲲鹏处理器运行应用。

使用鲲鹏指令实现适配逻辑。

Euler

使用Euler系统运行应用。

使用Euler系统调用实现适配逻辑。

数据库生态

GaussDB

使用GaussDB功能。

使用GaussDB的驱动和SQL实现适配逻辑。

GaussDB(DWS)

使用GaussDBDWS)功能。

使用GaussDB(DWS)的驱动和SQL实现适配逻辑。

存储生态

OBS

使用OBS功能。

基于OBS API访问实现适配逻辑。

鸿蒙生态

HarmonyOS

使用HarmonyOS系统运行应用。

使用HarmonyOS系统调用实现适配逻辑。

3 工作量评估和任务分解

3.1 工作量评估

任务

/

完成GaussDB数据库适配功能开发

2

完成DEMO设计和功能验证

2

基于CCE容器完成环境搭建和DEMO验证

1

输出开发资料和博客

1

代码推送上游社区和发布版本

2

总计

9人天

3.2 完成GaussDB数据库适配功能开发

Fork SQLAlchemy仓库(https://github.com/sqlalchemy/sqlalchemy/tree/main/lib/sqlalchemy/dialects) 开发SQLAlchemy相关的DBAPI以及SQLAlchemy Dialect(方言)插件开发然后通过实现GaussDBDialect定义来完成对接GaussDB数据库。

定义GaussDB特有的数据类型与SQLAlchemy类型的映射。

根据GaussDB的特性,可能需要对SQLAlchemy的性能进行优化。

编写测试用例来验证方言的功能,包括连接、查询、事务处理等。

参考:

SQLAlchemyPostgreSQL相关文档: https://docs.sqlalchemy.org/en/13/dialects/postgresql.html

源码阅读参考: https://developer.aliyun.com/article/929316

适配SQLAlchemy框架的OpenGauss方言库: https://gitee.com/opengauss/openGauss-sqlalchemy

3.3 完成GaussDB演示DEMO设计

参考下面的用例图:

SQLAlchemy 使用 DBAPI(Database 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 代码推送上游社区

将代码插件发布到SQLAlchemy仓库,包括版本说明、开发指南等。

仓库地址:https://github.com/sqlalchemy/sqlalchemy

4 验收材料

验收细则

评分说明

是否为验收必选项

结果(通过/不通过)

开发者举证

功能开发:完成与华为三大根技术生态(鲲鹏云、昇腾云、鸿蒙)适配的功能开发

完成GaussDB数据库适配功能开发。举证提供PR链接。

 

 

代码质量:适配华为三大根技术生态的代码质量经过工具检测达标

推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。

 

 

提供相关文档,比如部署文档、使用文档、配置文档等

根据社区要求,完善相关的开发指南和部署指导

 

 

合入到开源项目主仓:代码推送上游社区

代码合并到当前主干分支。举证提供代码仓库链接。

 

 

Deomo设计&开发:完成功能演示Demo的开发

举证提供DEMO仓库地址和DEMO开发提交记录。

 

 

Demo部署&验证:完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证

提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。

 

 

发布博客:发布博客介绍适配心得。

提供博客的地址。

 

 

制作单机版无高危开源镜像。

上架云商店。

 

 

单机版镜像上架时支持模板部署。

 

 

 

制作集群版无高危开源镜像

上架云商店。

 

 

集群版镜像上架时支持模板部署

 

 

 

 

5 参考资料

1. 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview


【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。