sandman2软件适配GaussDB开源验证任务

1 背景介绍

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

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

2 需求分析

2.1 项目影响力

Sandman2 是一个为现有数据库自动生成 RESTful API 的 Python 库（https://github.com/jeffknupp/sandman2），它允许开发者无需编写代码即可快速为数据库创建一个 RESTful API 服务。

项目数据：Fork 215, Star 2K, Contributor 20

star历史（https://star-history.com/）：

2.2 任务目的和范围

本任务的主要目的是让Sandman2社区支持GaussDB数据库，帮助拓展GaussDB的影响力，也方便GaussDB的用户能够将数据库由MySQL换成GaussDB。同时，该任务可以为一些项目迁移打下基础，方便用户在使用Sandman2的时候，可以选择GaussDB作为数据存储DB。

适配任务清单

3 工作量评估和任务分解

3.1 工作量评估

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

• Sandman2的数据库驱动引擎依赖的是SQLAlchemy的数据库驱动引擎，因此需要使SQLAlchemy兼容GaussDB的数据库，但可能需要对其进行扩展或定制以支持GaussDB特有的功能。
• 在Sandman2自动生成RESTful API时，可能需要兼容GaussDB的SQL语法，如果GaussDB有特定的SQL语法或函数，需要对其进行适配和开发工作。
• 默认不支持分布式数据库。这可能需要开发中间件或自定义数据库路由来处理数据分片和查询路由。

3.3 完成GaussDB演示DEMO设计

参考下面的用例图：

Sandman2使用SQLAlchemy的数据库引擎，SQLAlchemy使用DB API来实现数据库的访问，重点关注在自动生成RESTful API时，对GaussDB数据库的支持性，因为虽然GaussDB兼容 PostgreSQL 的 SQL 语法，但增加了一些扩展和功能，可能存在差异。

DEMO在resource-server-python中完成, https://Sandman2.readthedocs.io/en/latest/interacting.html的例子开发任务，通过RESTful API暴露数据库访问能力供前端使用。

DEMO的简单部署图如下：

3.4 DEMO开发、部署和验证

根据DEMO设计，完成演示功能开发和部署。要求使用CCE容器（Euler镜像）进行部署。

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

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

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

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

博客打上如下标签：

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

3.6 代码推送上游社区

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

4 验收材料

5 参考资料

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