Skip to content

Commit 3020b28

Browse files
committed
fix: update doc
1 parent b775098 commit 3020b28

File tree

2 files changed

+60
-62
lines changed

2 files changed

+60
-62
lines changed

README.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ This repository includes multiple plugins designed to resolve compatibility issu
88

99
OceanBase is a high-performance database compatible with both MySQL and Oracle protocols. This repository provides the following plugins to help developers address common compatibility issues in real-world applications:
1010

11-
| Plugin Name | Use Case | Key Features |
12-
| ------------------------------------------------------------------- | ------------------ | -------------------------------------------------------------------------------------- |
13-
| [Flyway OceanBase Plugin](./flyway-oceanbase-plugin/README.md) | Database Migration | Resolves compatibility issues when using Flyway with OceanBase in MySQL mode |
14-
| [Trino OceanBase Plugin](./trino-oceanbase-plugin/README.md) | Data Analysis | Enables Trino to connect to OceanBase (MySQL/Oracle mode) |
15-
| [WordPress OceanBase Plugin](./wordpress-oceanbase-plugin/README.md) | Content Management | Fixes compatibility issues between WordPress and OceanBase MySQL tenants |
16-
| [OceanBase SQL Helper Plugin](./oceanbase-sql-helper-plugin/README.md) | Development Tools | VSCode extension for quick access to OceanBase SQL keywords documentation |
17-
| [Metabase OceanBase Plugin](./metabase-oceanbase-plugin/README.md) | Data Visualization | Enables Metabase to connect to OceanBase (MySQL/Oracle mode) |
18-
| [OceanBase SQLAlchemy Plugin](./oceanbase-sqlalchemy-plugin/README.md) | Python ORM | SQLAlchemy dialect for OceanBase Oracle mode, compatible with SQLAlchemy 1.3+ and 2.0+ |
19-
| [OceanBase Dify Plugin](./dify-plugin-oceanbase/README.md) | AI Applications | Enables secure SQL query execution on OceanBase databases through Dify applications |
20-
| [LangGraph Checkpoint OceanBase Plugin](./langgraph-checkpoint-oceanbase-plugin/README.md) | LangGraph CheckpointSaver| Implementation of LangGraph CheckpointSaver that uses OceanBase MySQL mode|
11+
| Plugin Name | Use Case | Key Features |
12+
| --------------------------------------------------------------------------------------- | ------------------------- | -------------------------------------------------------------------------------------- |
13+
| [Flyway OceanBase Plugin](./flyway-oceanbase-plugin/README.md) | Database Migration | Resolves compatibility issues when using Flyway with OceanBase in MySQL mode |
14+
| [Trino OceanBase Plugin](./trino-oceanbase-plugin/README.md) | Data Analysis | Enables Trino to connect to OceanBase (MySQL/Oracle mode) |
15+
| [WordPress OceanBase Plugin](./wordpress-oceanbase-plugin/README.md) | Content Management | Fixes compatibility issues between WordPress and OceanBase MySQL tenants |
16+
| [OceanBase SQL Helper Plugin](./oceanbase-sql-helper-plugin/README.md) | Development Tools | VSCode extension for quick access to OceanBase SQL keywords documentation |
17+
| [Metabase OceanBase Plugin](./metabase-oceanbase-plugin/README.md) | Data Visualization | Enables Metabase to connect to OceanBase (MySQL/Oracle mode) |
18+
| [OceanBase SQLAlchemy Plugin](./oceanbase-sqlalchemy-plugin/README.md) | Python ORM | SQLAlchemy dialect for OceanBase Oracle mode, compatible with SQLAlchemy 1.3+ and 2.0+ |
19+
| [OceanBase Dify Plugin](./dify-plugin-oceanbase/README.md) | AI Applications | Enables secure SQL query execution on OceanBase databases through Dify applications |
20+
| [LangGraph Checkpoint OceanBase Plugin](./langgraph-checkpoint-oceanbase-plugin/README.md) | LangGraph CheckpointSaver | Implementation of LangGraph CheckpointSaver that uses OceanBase MySQL mode |
2121

2222
---
2323

@@ -76,11 +76,10 @@ OceanBase is a high-performance database compatible with both MySQL and Oracle p
7676
- **Function**: A Dify plugin for connecting to and querying OceanBase databases. This project has been migrated to a new repository.
7777
- **Use Case**: AI applications that need to interact with OceanBase databases through Dify platform for data querying and manipulation.
7878
- **Documentation**: [OceanBase Dify Plugin](./dify-plugin-oceanbase/README.md)
79-
- **New Repository**: https://github.com/oceanbase/dify-plugin-oceanbase
79+
- **Repository**: https://github.com/oceanbase/dify-plugin-oceanbase
8080

8181
---
8282

83-
8483
### ✅ LangGraph Checkpoint OceanBase Plugin
8584

8685
- **Function**: OceanBase MySQL mode can be used as LangGraph's CheckpointSaver to preserve both short-term and long-term memory.
@@ -89,18 +88,17 @@ OceanBase is a high-performance database compatible with both MySQL and Oracle p
8988

9089
---
9190

92-
9391
## 📚 Full Documentation Links
9492

95-
| Plugin Name | Documentation Link |
96-
| --------------------------- | ------------------------------------------------------------------- |
97-
| Flyway OceanBase Plugin | [Flyway OceanBase Plugin](./flyway-oceanbase-plugin/README.md) |
98-
| Trino OceanBase Plugin | [Trino OceanBase Plugin](./trino-oceanbase-plugin/README.md) |
99-
| WordPress OceanBase Plugin | [WordPress OceanBase Plugin](./wordpress-oceanbase-plugin/README.md) |
100-
| OceanBase SQL Helper Plugin | [OceanBase SQL Helper Plugin](./oceanbase-sql-helper-plugin/README.md) |
101-
| Metabase OceanBase Plugin | [Metabase OceanBase Plugin](./metabase-oceanbase-plugin/README.md) |
102-
| OceanBase SQLAlchemy Plugin | [OceanBase SQLAlchemy Plugin](./oceanbase-sqlalchemy-plugin/README.md) |
103-
| OceanBase Dify Plugin | [OceanBase Dify Plugin](./dify-plugin-oceanbase/README.md) |
93+
| Plugin Name | Documentation Link |
94+
| ------------------------------------- | --------------------------------------------------------------------------------------- |
95+
| Flyway OceanBase Plugin | [Flyway OceanBase Plugin](./flyway-oceanbase-plugin/README.md) |
96+
| Trino OceanBase Plugin | [Trino OceanBase Plugin](./trino-oceanbase-plugin/README.md) |
97+
| WordPress OceanBase Plugin | [WordPress OceanBase Plugin](./wordpress-oceanbase-plugin/README.md) |
98+
| OceanBase SQL Helper Plugin | [OceanBase SQL Helper Plugin](./oceanbase-sql-helper-plugin/README.md) |
99+
| Metabase OceanBase Plugin | [Metabase OceanBase Plugin](./metabase-oceanbase-plugin/README.md) |
100+
| OceanBase SQLAlchemy Plugin | [OceanBase SQLAlchemy Plugin](./oceanbase-sqlalchemy-plugin/README.md) |
101+
| OceanBase Dify Plugin | [OceanBase Dify Plugin](./dify-plugin-oceanbase/README.md) |
104102
| LangGraph Checkpoint OceanBase Plugin | [LangGraph Checkpoint OceanBase Plugin](./langgraph-checkpoint-oceanbase-plugin/README.md) |
105103

106104
---

README_CN.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,27 @@
22

33
本仓库包含多个插件,旨在解决 **OceanBase** 与不同框架/工具(如 Flyway、Trino、WordPressd等)之间的兼容性问题。每个插件针对特定场景优化,确保数据库操作的稳定性与高效性。
44

5-
------
5+
---
66

77
## 🧩 项目概述
88

99
OceanBase 是一款兼容 MySQL 和 Oracle 协议的高性能数据库。本仓库提供以下插件,帮助开发者在实际应用中解决常见兼容性问题:
1010

1111
全屏复制
1212

13-
| 插件名称 | 适用场景 | 主要功能 |
14-
|------------------------------------------------------------------------------------------------------------| ---------- | -------------------------------------------------- |
15-
| [Flyway OceanBase 插件](./flyway-oceanbase-plugin/README_CN.md) | 数据库迁移 | 解决 Flyway 在 OceanBase MySQL 模式下的兼容性问题 |
16-
| [Trino OceanBase 插件](./trino-oceanbase-plugin/README_CN.md) | 数据分析 | 支持 Trino 连接 OceanBase(MySQL/Oracle 模式) |
17-
| [WordPress OceanBase 插件](./wordpress-oceanbase-plugin/README_CN.md) | 内容管理 | 修复 WordPress 与 OceanBase MySQL 租户的兼容性问题 |
18-
| [OceanBase SQL 助手插件](./oceanbase-sql-helper-plugin/README_CN.md) | 开发工具 | VSCode 插件,快速访问 OceanBase SQL 关键词文档 |
19-
| [Metabase OceanBase 插件](./metabase-oceanbase-plugin/README_CN.md) | 数据可视化 | 支持 Metabase 连接 OceanBase(MySQL/Oracle 模式) |
20-
| [OceanBase SQLAlchemy 插件](./oceanbase-sqlalchemy-plugin/README.md) | Python ORM | SQLAlchemy 方言,支持 OceanBase Oracle 模式,兼容 SQLAlchemy 1.3+ 和 2.0+ |
21-
| [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README.md) | 保存 LangGraph 的 checkpoint | 使用 OceanBase MySQL 模式实现了 LangGraph CheckpointSaver |
22-
| [OceanBase Dify 插件](./dify-plugin-oceanbase/README_CN.md) | AI 应用 | 通过 Dify 应用程序在 OceanBase 数据库上安全执行 SQL 查询 |
23-
| [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README_CN.md) | 保存 LangGraph 的 checkpoint | 使用 OceanBase MySQL 模式实现了 LangGraph CheckpointSaver |
24-
------
13+
| 插件名称 | 适用场景 | 主要功能 |
14+
| ---------------------------------------------------------------------------------------- | ---------------------------- | ------------------------------------------------------------------------- |
15+
| [Flyway OceanBase 插件](./flyway-oceanbase-plugin/README_CN.md) | 数据库迁移 | 解决 Flyway 在 OceanBase MySQL 模式下的兼容性问题 |
16+
| [Trino OceanBase 插件](./trino-oceanbase-plugin/README_CN.md) | 数据分析 | 支持 Trino 连接 OceanBase(MySQL/Oracle 模式) |
17+
| [WordPress OceanBase 插件](./wordpress-oceanbase-plugin/README_CN.md) | 内容管理 | 修复 WordPress 与 OceanBase MySQL 租户的兼容性问题 |
18+
| [OceanBase SQL 助手插件](./oceanbase-sql-helper-plugin/README_CN.md) | 开发工具 | VSCode 插件,快速访问 OceanBase SQL 关键词文档 |
19+
| [Metabase OceanBase 插件](./metabase-oceanbase-plugin/README_CN.md) | 数据可视化 | 支持 Metabase 连接 OceanBase(MySQL/Oracle 模式) |
20+
| [OceanBase SQLAlchemy 插件](./oceanbase-sqlalchemy-plugin/README.md) | Python ORM | SQLAlchemy 方言,支持 OceanBase Oracle 模式,兼容 SQLAlchemy 1.3+ 和 2.0+ |
21+
| [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README.md) | 保存 LangGraph 的 checkpoint | 使用 OceanBase MySQL 模式实现了 LangGraph CheckpointSaver |
22+
| [OceanBase Dify 插件](./dify-plugin-oceanbase/README_CN.md) | AI 应用 | 通过 Dify 应用程序在 OceanBase 数据库上安全执行 SQL 查询 |
23+
| [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README_CN.md) | 保存 LangGraph 的 checkpoint | 使用 OceanBase MySQL 模式实现了 LangGraph CheckpointSaver |
24+
25+
---
2526

2627
## 📁 插件详情
2728

@@ -31,106 +32,105 @@ OceanBase 是一款兼容 MySQL 和 Oracle 协议的高性能数据库。本仓
3132
- **适用场景**:使用 Flyway 管理 OceanBase MySQL 模式的数据库迁移。
3233
- **详细文档**[Flyway OceanBase 插件](./flyway-oceanbase-plugin/README_CN.md)
3334

34-
------
35+
---
3536

3637
### ✅ Trino OceanBase 插件
3738

3839
- **功能**:支持 Trino 连接 OceanBase(MySQL/Oracle 模式),优化 SQL 查询与事务处理。
3940
- **适用场景**:通过 Trino 查询 OceanBase 数据库(支持多模式)。
4041
- **详细文档**[Trino OceanBase 插件](./trion-oceanbase-plugin/README_CN.md)
4142

42-
------
43+
---
4344

4445
### ✅ WordPress OceanBase 插件
4546

4647
- **功能**:修复 WordPress 与 OceanBase MySQL 租户的兼容性问题(如表别名限制)。
4748
- **适用场景**:WordPress 部署在 OceanBase MySQL 租户时的兼容性适配。
4849
- **详细文档**[WordPress OceanBase 插件](./wordpress-oceanbase-plugin/README_CN.md)
4950

50-
------
51+
---
5152

5253
### ✅ OceanBase SQL 助手插件
5354

5455
- **功能**:VSCode 插件,提供 OceanBase SQL 关键词文档的快速访问,支持悬停提示和直接导航。
5556
- **适用场景**:增强开发者在编写 OceanBase 数据库 SQL 查询时的开发体验。
5657
- **详细文档**[OceanBase SQL 助手插件](./oceanbase-sql-helper-plugin/README_CN.md)
5758

58-
------
59+
---
5960

6061
### ✅ Metabase OceanBase 插件
6162

6263
- **功能**:支持 Metabase 连接 OceanBase(MySQL/Oracle 模式),自动检测兼容模式并适配相应 SQL 语法。
6364
- **适用场景**:使用 Metabase 进行数据分析和可视化,连接 OceanBase 数据库。
6465
- **详细文档**[Metabase OceanBase 插件](./metabase-oceanbase-plugin/README_CN.md)
6566

66-
------
67+
---
6768

6869
### ✅ OceanBase SQLAlchemy 插件
6970

7071
- **功能**:SQLAlchemy 方言,支持 OceanBase Oracle 模式,完全兼容 SQLAlchemy 1.3.x 和 2.0+,提供优化的 SQL 查询和约束反射。
7172
- **适用场景**:使用 Python SQLAlchemy ORM 框架连接和操作 OceanBase Oracle 模式数据库。
7273
- **详细文档**[OceanBase SQLAlchemy 插件](./oceanbase-sqlalchemy-plugin/README.md)
7374

74-
------
75+
---
7576

7677
### ✅ LangGraph Checkpoint OceanBase 插件
7778

7879
- **功能**:使用 OceanBase MySQL 模式实现了 LangGraph CheckpointSaver。
7980
- **适用场景**:使用 OceanBase 作为 LangGraph 的 Checkpointer。
8081
- **详细文档**[LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README.md)
8182

82-
------
83+
---
8384

8485
### ✅ OceanBase Dify 插件
8586

8687
- **功能**:用于连接和查询 OceanBase 数据库的 Dify 插件。此项目已迁移到新仓库。
8788
- **适用场景**:需要通过 Dify 平台与 OceanBase 数据库交互进行数据查询和操作的 AI 应用程序。
8889
- **详细文档**[OceanBase Dify 插件](./dify-plugin-oceanbase/README_CN.md)
89-
- **新仓库地址**https://github.com/oceanbase/dify-plugin-oceanbase
90+
- **仓库地址**https://github.com/oceanbase/dify-plugin-oceanbase
9091

91-
------
92+
---
9293

9394
### ✅ LangGraph Checkpoint OceanBase 插件
9495

9596
- **功能**:使用 OceanBase MySQL 模式实现了 LangGraph CheckpointSaver。
9697
- **适用场景**:使用 OceanBase 作为 LangGraph 的 Checkpointer。
9798
- **详细文档**[LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README_CN.md)
9899

99-
------
100-
100+
---
101101

102102
## 📚 完整文档链接
103103

104-
| 插件名称 | 文档链接 |
105-
| --------------------------- | ------------------------------------------------------------ |
106-
| Flyway OceanBase MySQL 插件 | [Flyway OceanBase 插件](./flyway-oceanbase-plugin/README_CN.md) |
107-
| Trino OceanBase 插件 | [Trino OceanBase 插件](./trino-oceanbase-plugin/README_CN.md) |
108-
| WordPress OceanBase 插件 | [WordPress OceanBase 插件](./wordpress-oceanbase-plugin/README_CN.md) |
109-
| OceanBase SQL 助手插件 | [OceanBase SQL 助手插件](./oceanbase-sql-helper-plugin/README_CN.md) |
110-
| Metabase OceanBase 插件 | [Metabase OceanBase 插件](./metabase-oceanbase-plugin/README_CN.md) |
111-
| OceanBase SQLAlchemy 插件 | [OceanBase SQLAlchemy 插件](./oceanbase-sqlalchemy-plugin/README.md) |
112-
| LangGraph Checkpoint OceanBase 插件 | [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README.md) |
113-
| OceanBase Dify 插件 | [OceanBase Dify 插件](./dify-plugin-oceanbase/README_CN.md) |
114-
| LangGraph Checkpoint OceanBase 插件 | [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README_CN.md) |
104+
| 插件名称 | 文档链接 |
105+
| ----------------------------------- | ---------------------------------------------------------------------------------------- |
106+
| Flyway OceanBase MySQL 插件 | [Flyway OceanBase 插件](./flyway-oceanbase-plugin/README_CN.md) |
107+
| Trino OceanBase 插件 | [Trino OceanBase 插件](./trino-oceanbase-plugin/README_CN.md) |
108+
| WordPress OceanBase 插件 | [WordPress OceanBase 插件](./wordpress-oceanbase-plugin/README_CN.md) |
109+
| OceanBase SQL 助手插件 | [OceanBase SQL 助手插件](./oceanbase-sql-helper-plugin/README_CN.md) |
110+
| Metabase OceanBase 插件 | [Metabase OceanBase 插件](./metabase-oceanbase-plugin/README_CN.md) |
111+
| OceanBase SQLAlchemy 插件 | [OceanBase SQLAlchemy 插件](./oceanbase-sqlalchemy-plugin/README.md) |
112+
| LangGraph Checkpoint OceanBase 插件 | [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README.md) |
113+
| OceanBase Dify 插件 | [OceanBase Dify 插件](./dify-plugin-oceanbase/README_CN.md) |
114+
| LangGraph Checkpoint OceanBase 插件 | [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README_CN.md) |
115115

116-
------
116+
---
117117

118118
## 🛠️ 贡献与反馈
119119

120120
欢迎提交 Issues 或 Pull Request,帮助完善插件功能。
121121

122-
- [GitHub Issues]( https://github.com/oceanbase/ecology-plugins/issues)
122+
- [GitHub Issues](https://github.com/oceanbase/ecology-plugins/issues)
123123

124-
------
124+
---
125125

126126
## 📄 授权协议
127127

128128
本项目采用 [Apache License 2.0](./LICENSE) 协议开源。
129129

130-
------
130+
---
131131

132132
## 📌 注意事项
133133

134134
- 每个插件的详细配置与使用方法,请参考对应文档。
135135
- 确保 OceanBase 版本与插件兼容(建议 ≥ 3.1.0)。
136-
- 插件适用于 MySQL/Oracle 模式,需根据实际环境选择适配版本。
136+
- 插件适用于 MySQL/Oracle 模式,需根据实际环境选择适配版本。

0 commit comments

Comments
 (0)