Skip to content

Commit 897b04a

Browse files
xxsc0529xxsc0529
authored
Merge pull request #14 from xxsc0529/main
fix:update doc
2 parents 25d31e2 + 8b46104 commit 897b04a

File tree

2 files changed

+29
-41
lines changed

2 files changed

+29
-41
lines changed

‎README.md‎

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

33
This repository includes multiple plugins designed to resolve compatibility issues between **OceanBase** and various frameworks/tools (such as Flyway, Trino, and WordPress). Each plugin is optimized for specific scenarios to ensure stable and efficient database operations.
44

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

77
## 🧩 Project Overview
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) |
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](https://github.com/xxsc0529/metabase/blob/90aa386bf6d9050dec00ce88da401b69c9bb544e/README.md) | Data Visualization | Enables Metabase to connect to OceanBase (MySQL/Oracle mode) |
1818
| [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-
| [LangGraph Checkpoint OceanBase Plugin](./langgraph-checkpoint-oceanbase-plugin/README.md) | LangGraph CheckpointSaver| Implementation of LangGraph CheckpointSaver that uses OceanBase MySQL mode|
2019

21-
------
20+
---
2221

2322
## 📁 Plugin Details
2423

@@ -28,87 +27,76 @@ OceanBase is a high-performance database compatible with both MySQL and Oracle p
2827
- **Use Case**: Managing database migrations for OceanBase MySQL mode using Flyway.
2928
- **Documentation**: [Flyway OceanBase Plugin](./flyway-oceanbase-plugin/README.md)
3029

31-
------
30+
---
3231

3332
### ✅ Trino OceanBase Plugin
3433

3534
- **Function**: Enables Trino to connect to OceanBase (MySQL/Oracle mode), optimizing SQL queries and transaction handling.
3635
- **Use Case**: Querying OceanBase databases via Trino (supports both modes).
3736
- **Documentation**: [Trino OceanBase Plugin](./trino-oceanbase-plugin/README.md)
3837

39-
------
38+
---
4039

4140
### ✅ WordPress OceanBase Plugin
4241

4342
- **Function**: Fixes compatibility issues between WordPress and OceanBase MySQL tenants (e.g., table alias restrictions).
4443
- **Use Case**: Ensuring WordPress compatibility when deployed on OceanBase MySQL tenants.
4544
- **Documentation**: [WordPress OceanBase Plugin](./wordpress-oceanbase-plugin/README.md)
4645

47-
------
46+
---
4847

4948
### ✅ OceanBase SQL Helper Plugin
5049

5150
- **Function**: VSCode extension that provides quick access to OceanBase SQL keywords documentation with hover tooltips and direct navigation.
5251
- **Use Case**: Enhancing developer experience when writing SQL queries for OceanBase databases.
5352
- **Documentation**: [OceanBase SQL Helper Plugin](./oceanbase-sql-helper-plugin/README.md)
5453

55-
------
54+
---
5655

5756
### ✅ Metabase OceanBase Plugin
5857

5958
- **Function**: Enables Metabase to connect to OceanBase (MySQL/Oracle mode) with automatic compatibility mode detection and SQL syntax adaptation.
6059
- **Use Case**: Data analysis and visualization using Metabase connected to OceanBase databases.
61-
- **Documentation**: [Metabase OceanBase Plugin](./metabase-oceanbase-plugin/README.md)
60+
- **Documentation**: [Metabase OceanBase Plugin](https://github.com/xxsc0529/metabase/blob/90aa386bf6d9050dec00ce88da401b69c9bb544e/README.md)
6261

63-
------
62+
---
6463

6564
### ✅ OceanBase SQLAlchemy Plugin
6665

6766
- **Function**: SQLAlchemy dialect for OceanBase Oracle mode, fully compatible with SQLAlchemy 1.3.x and 2.0+, providing optimized SQL queries and constraint reflection.
6867
- **Use Case**: Using Python SQLAlchemy ORM framework to connect and operate OceanBase Oracle mode databases.
6968
- **Documentation**: [OceanBase SQLAlchemy Plugin](./oceanbase-sqlalchemy-plugin/README.md)
7069

71-
------
72-
73-
### ✅ LangGraph Checkpoint OceanBase Plugin
74-
75-
- **Function**: OceanBase MySQL mode can be used as LangGraph's CheckpointSaver to preserve both short-term and long-term memory.
76-
- **Use Case**: Using OceanBase as LangGraph's Checkpointer.
77-
- **Documentation**: [LangGraph Checkpoint OceanBase Plugin](./langgraph-checkpoint-oceanbase-plugin/README.md)
78-
79-
------
70+
---
8071

8172
## 📚 Full Documentation Links
8273

83-
全屏复制
84-
85-
| Plugin Name | Documentation Link |
86-
| -------------------------- | ------------------------------------------------------------ |
87-
| Flyway OceanBase Plugin | [Flyway OceanBase Plugin](./flyway-oceanbase-plugin/README.md) |
88-
| Trino OceanBase Plugin | [Trino OceanBase Plugin](./trino-oceanbase-plugin/README.md) |
89-
| WordPress OceanBase Plugin | [WordPress OceanBase Plugin](./wordpress-oceanbase-plugin/README.md) |
74+
| Plugin Name | Documentation Link |
75+
| --------------------------- | ------------------------------------------------------------------- |
76+
| Flyway OceanBase Plugin | [Flyway OceanBase Plugin](./flyway-oceanbase-plugin/README.md) |
77+
| Trino OceanBase Plugin | [Trino OceanBase Plugin](./trino-oceanbase-plugin/README.md) |
78+
| WordPress OceanBase Plugin | [WordPress OceanBase Plugin](./wordpress-oceanbase-plugin/README.md) |
9079
| OceanBase SQL Helper Plugin | [OceanBase SQL Helper Plugin](./oceanbase-sql-helper-plugin/README.md) |
91-
| Metabase OceanBase Plugin | [Metabase OceanBase Plugin](./metabase-oceanbase-plugin/README.md) |
80+
| Metabase OceanBase Plugin | [Metabase OceanBase Plugin](https://github.com/xxsc0529/metabase/blob/90aa386bf6d9050dec00ce88da401b69c9bb544e/README.md) |
9281
| OceanBase SQLAlchemy Plugin | [OceanBase SQLAlchemy Plugin](./oceanbase-sqlalchemy-plugin/README.md) |
93-
| LangGraph Checkpoint OceanBase Plugin | [LangGraph Checkpoint OceanBase Plugin](./langgraph-checkpoint-oceanbase-plugin/README.md) |
9482

95-
------
83+
---
9684

9785
## 🛠️ Contributing & Feedback
9886

9987
We welcome contributions via **Issues** or **Pull Requests**.
10088
For questions or suggestions, visit [GitHub Issues](https://github.com/oceanbase/ecology-plugins/issues).
10189

102-
------
90+
---
10391

10492
## 📄 License
10593

10694
This project is licensed under the [Apache License 2.0](./LICENSE).
10795

108-
------
96+
---
10997

11098
## 📌 Notes
11199

112100
- For detailed configuration and usage instructions, refer to the respective plugin documentation.
113101
- Ensure OceanBase version compatibility (recommended ≥ 3.1.0).
114-
- Plugins support MySQL/Oracle modes; select the appropriate version based on your environment.
102+
- Plugins support MySQL/Oracle modes; select the appropriate version based on your environment.

‎README_CN.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ OceanBase 是一款兼容 MySQL 和 Oracle 协议的高性能数据库。本仓
1616
| [Trino OceanBase 插件](./trino-oceanbase-plugin/README_CN.md) | 数据分析 | 支持 Trino 连接 OceanBase（MySQL/Oracle 模式） |
1717
| [WordPress OceanBase 插件](./wordpress-oceanbase-plugin/README_CN.md) | 内容管理 | 修复 WordPress 与 OceanBase MySQL 租户的兼容性问题 |
1818
| [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 模式） |
19+
| [Metabase OceanBase 插件](https://github.com/xxsc0529/metabase/blob/90aa386bf6d9050dec00ce88da401b69c9bb544e/README.md) | 数据可视化 | 支持 Metabase 连接 OceanBase（MySQL/Oracle 模式） |
2020
| [OceanBase SQLAlchemy 插件](./oceanbase-sqlalchemy-plugin/README.md) | Python ORM | SQLAlchemy 方言，支持 OceanBase Oracle 模式，兼容 SQLAlchemy 1.3+ 和 2.0+ |
2121
| [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README.md) | 保存 LangGraph 的 checkpoint | 使用 OceanBase MySQL 模式实现了 LangGraph CheckpointSaver |
2222

@@ -60,7 +60,7 @@ OceanBase 是一款兼容 MySQL 和 Oracle 协议的高性能数据库。本仓
6060

6161
- **功能**：支持 Metabase 连接 OceanBase（MySQL/Oracle 模式），自动检测兼容模式并适配相应 SQL 语法。
6262
- **适用场景**：使用 Metabase 进行数据分析和可视化，连接 OceanBase 数据库。
63-
- **详细文档**：[Metabase OceanBase 插件](./metabase-oceanbase-plugin/README_CN.md)
63+
- **详细文档**：[Metabase OceanBase 插件](https://github.com/xxsc0529/metabase/blob/90aa386bf6d9050dec00ce88da401b69c9bb544e/README.md)
6464

6565
------
6666

@@ -88,7 +88,7 @@ OceanBase 是一款兼容 MySQL 和 Oracle 协议的高性能数据库。本仓
8888
| Trino OceanBase 插件 | [Trino OceanBase 插件](./trino-oceanbase-plugin/README_CN.md) |
8989
| WordPress OceanBase 插件 | [WordPress OceanBase 插件](./wordpress-oceanbase-plugin/README_CN.md) |
9090
| OceanBase SQL 助手插件 | [OceanBase SQL 助手插件](./oceanbase-sql-helper-plugin/README_CN.md) |
91-
| Metabase OceanBase 插件 | [Metabase OceanBase 插件](./metabase-oceanbase-plugin/README_CN.md) |
91+
| Metabase OceanBase 插件 | [Metabase OceanBase 插件](https://github.com/xxsc0529/metabase/blob/90aa386bf6d9050dec00ce88da401b69c9bb544e/README.md) |
9292
| OceanBase SQLAlchemy 插件 | [OceanBase SQLAlchemy 插件](./oceanbase-sqlalchemy-plugin/README.md) |
9393
| LangGraph Checkpoint OceanBase 插件 | [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README.md) |
9494

0 commit comments

Comments
 (0)