ent适配GaussDB开源开发任务

举报
pengcss 发表于 2024/10/28 16:04:07 2024/10/28
【摘要】 ent是一个简单而又功能强大的Go语言ORM框架。本任务的主要目的是让ent支持GaussDB数据库,帮助拓展GaussDB的影响力,方便ent的用户能够顺利对接GaussDB数据库。同时,该任务可以为一些项目迁移打下基础,方便用户在做方案选型时,可以选择GaussDB作为ent的长期后端存储。

1       背景介绍

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

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

2       需求分析

2.1      开源软件基本情况

ent是一个简单而又功能强大的Go语言ORM框架,易于构建和维护应用程序与大数据模型。它引入Scheme即代码的理念,允许以Go对象的形式定义任务数据库模型和图形结构,不仅如此,ent还支持轻松查询、聚合以及任意图形结构的遍历,提供了一个完全静态类型且明确的API

源码地址:https://github.com/ent/ent

官网主页:https://entgo.io

主要开发语言:Go

LICENSEApache 2.0

项目数据:Fork 925, Star 15.6K, Contributor 229,最近一次提交:2024-10-21

star历史(https://star-history.com/):


 

2.2      任务目的和范围

本任务的主要目的是让ent支持GaussDB数据库,帮助拓展GaussDB的影响力,方便ent的用户能够顺利对接GaussDB数据库。同时,该任务可以为一些项目迁移打下基础,方便用户在做方案选型时,可以选择GaussDB作为ent的长期后端存储。

 

  • 能力要求

完成该任务需要具备微服务开发经验,使用过DevOps工具,熟悉ent的使用方法。开发过程中主要使用Go语言,演示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       工作量评估

任务

/

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

2

完成DEMO设计和功能验证

2

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

1

输出开发资料和博客

1

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

2

总计

9人天

 

4       任务分解

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


DialectORM框架用于适配不同数据库SQL语法的抽象层,确保ORM可以生成特定数据库特性的SQL

  • 基于以下GaussDB第三方驱动进行扩展:https://support.huaweicloud.com/distributed-devg-v8-gaussdb/gaussdb-12-0231.html
  • 在GitCode完成项目Fork。
  • 实现sqlDialect接口,使其支持GaussDB的特定数据库语法和特性。
  • 在entc/gen中修改Storage,在已支持的dialects中添加GaussDB选项,使其能够支持生成GaussDB相关代码。
  • 在ent仓库中导入已适配的GaussDB的依赖库,并完成GaussDB的配置和使用示例。

 

4.2      完成DEMO设计

DEMO的部署图如下:

开发者需要在这个DEMO的资源服务完成ent的数据库访问功能开发和界面展示。

 

4.3      DEMO开发、部署和验证

根据DEMO设计,完成演示功能开发和部署。要求使用CCE容器(Euler镜像)进行部署。部署成功后,通过访问DEMO提供的界面,能够看到数据库访问的功能演示结果。

 

4.4      在华为云开发者论坛输出博客

访问华为云开发者论坛(参考:https://bbs.huaweicloud.com/blogs)发表博客,介绍完成这些任务的过程和心得。

 

内容包括不限于如下内容:

  • 开源for Huawei的背景
  • 开源软件的功能介绍
  • 开发适配过程及碰到和解决的问题
  • DEMO设计、开发、部署过程
  • 代码推送开源社区及互动过程

 

博客打上如下标签:

  • 开源(必选)
  • 开发者(必选)
  • GaussDB数据库(可选)
  • 云数据库 GaussDB(可选)
  • 鲲鹏(可选)
  • 昇腾(可选)
  • 鸿蒙(可选)
  • 对象存储 OBS(可选)

 

4.5      代码推送上游社区

将代码合并到ent官网主干代码;更新ent官网资料,包括版本说明、开发指南等。

 

5       验收材料

验收细则

评分说明

是否为验收必选项

结果(通过/不通过)

开发者举证

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

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

 

 

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

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

 

 

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

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

 

 

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

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

 

 

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

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

 

 

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

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

 

 

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

提供博客的地址。

 

 

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

上架云商店。

 

 

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

 

 

 

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

上架云商店。

 

 

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

 

 

 

 

 

6       参考资料

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

评论(0

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

全部回复

上滑加载中

设置昵称

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

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

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