https://github.com/oceanbase/ecology-plugins
Code for plugins adapt the compatibility of OceanBase's ecosystem
https://github.com/oceanbase/ecology-plugins
Last synced: 3 months ago
JSON representation
Code for plugins adapt the compatibility of OceanBase's ecosystem
- Host: GitHub
- URL: https://github.com/oceanbase/ecology-plugins
- Owner: oceanbase
- License: apache-2.0
- Created: 2025-06-24T08:24:23.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-07-11T07:18:09.000Z (6 months ago)
- Last Synced: 2025-07-11T10:53:05.487Z (6 months ago)
- Language: Java
- Homepage:
- Size: 365 KB
- Stars: 2
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OceanBase Ecosystem Plugins Collection
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.
---
## 🧩 Project Overview
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:
| Plugin Name | Use Case | Key Features |
| --------------------------------------------------------------------------------------- | ------------------------- | -------------------------------------------------------------------------------------- |
| [Flyway OceanBase Plugin](./flyway-oceanbase-plugin/README.md) | Database Migration | Resolves compatibility issues when using Flyway with OceanBase in MySQL mode |
| [Trino OceanBase Plugin](./trino-oceanbase-plugin/README.md) | Data Analysis | Enables Trino to connect to OceanBase (MySQL/Oracle mode) |
| [WordPress OceanBase Plugin](./wordpress-oceanbase-plugin/README.md) | Content Management | Fixes compatibility issues between WordPress and OceanBase MySQL tenants |
| [OceanBase SQL Helper Plugin](./oceanbase-sql-helper-plugin/README.md) | Development Tools | VSCode extension for quick access to OceanBase SQL keywords documentation |
| [Metabase OceanBase Plugin](./metabase-oceanbase-plugin/README.md) | Data Visualization | Enables Metabase to connect to OceanBase (MySQL/Oracle mode) |
| [OceanBase SQLAlchemy Plugin](./oceanbase-sqlalchemy-plugin/README.md) | Python ORM | SQLAlchemy dialect for OceanBase Oracle mode, compatible with SQLAlchemy 1.3+ and 2.0+ |
| [OceanBase Dify Plugin](./dify-plugin-oceanbase/README.md) | AI Applications | Enables secure SQL query execution on OceanBase databases through Dify applications |
| [LangGraph Checkpoint OceanBase Plugin](./langgraph-checkpoint-oceanbase-plugin/README.md) | LangGraph CheckpointSaver | Implementation of LangGraph CheckpointSaver that uses OceanBase MySQL mode |
---
## 📁 Plugin Details
### ✅ Flyway OceanBase MySQL Plugin
- **Function**: Resolves compatibility issues when using Flyway with OceanBase in MySQL mode (e.g., `version` column conflicts, driver compatibility).
- **Use Case**: Managing database migrations for OceanBase MySQL mode using Flyway.
- **Documentation**: [Flyway OceanBase Plugin](./flyway-oceanbase-plugin/README.md)
---
### ✅ Trino OceanBase Plugin
- **Function**: Enables Trino to connect to OceanBase (MySQL/Oracle mode), optimizing SQL queries and transaction handling.
- **Use Case**: Querying OceanBase databases via Trino (supports both modes).
- **Documentation**: [Trino OceanBase Plugin](./trino-oceanbase-plugin/README.md)
---
### ✅ WordPress OceanBase Plugin
- **Function**: Fixes compatibility issues between WordPress and OceanBase MySQL tenants (e.g., table alias restrictions).
- **Use Case**: Ensuring WordPress compatibility when deployed on OceanBase MySQL tenants.
- **Documentation**: [WordPress OceanBase Plugin](./wordpress-oceanbase-plugin/README.md)
---
### ✅ OceanBase SQL Helper Plugin
- **Function**: VSCode extension that provides quick access to OceanBase SQL keywords documentation with hover tooltips and direct navigation.
- **Use Case**: Enhancing developer experience when writing SQL queries for OceanBase databases.
- **Documentation**: [OceanBase SQL Helper Plugin](./oceanbase-sql-helper-plugin/README.md)
---
### ✅ Metabase OceanBase Plugin
- **Function**: Enables Metabase to connect to OceanBase (MySQL/Oracle mode) with automatic compatibility mode detection and SQL syntax adaptation.
- **Use Case**: Data analysis and visualization using Metabase connected to OceanBase databases.
- **Documentation**: [Metabase OceanBase Plugin](./metabase-oceanbase-plugin/README.md)
---
### ✅ OceanBase SQLAlchemy Plugin
- **Function**: SQLAlchemy dialect for OceanBase Oracle mode, fully compatible with SQLAlchemy 1.3.x and 2.0+, providing optimized SQL queries and constraint reflection.
- **Use Case**: Using Python SQLAlchemy ORM framework to connect and operate OceanBase Oracle mode databases.
- **Documentation**: [OceanBase SQLAlchemy Plugin](./oceanbase-sqlalchemy-plugin/README.md)
---
### ✅ OceanBase Dify Plugin
- **Function**: A Dify plugin for connecting to and querying OceanBase databases. This project has been migrated to a new repository.
- **Use Case**: AI applications that need to interact with OceanBase databases through Dify platform for data querying and manipulation.
- **Documentation**: [OceanBase Dify Plugin](./dify-plugin-oceanbase/README.md)
- **Repository**: https://github.com/oceanbase/dify-plugin-oceanbase
---
### ✅ LangGraph Checkpoint OceanBase Plugin
- **Function**: OceanBase MySQL mode can be used as LangGraph's CheckpointSaver to preserve both short-term and long-term memory.
- **Use Case**: Using OceanBase as LangGraph's Checkpointer.
- **Documentation**: [LangGraph Checkpoint OceanBase Plugin](./langgraph-checkpoint-oceanbase-plugin/README.md)
---
## 📚 Full Documentation Links
| Plugin Name | Documentation Link |
| ------------------------------------- | --------------------------------------------------------------------------------------- |
| Flyway OceanBase Plugin | [Flyway OceanBase Plugin](./flyway-oceanbase-plugin/README.md) |
| Trino OceanBase Plugin | [Trino OceanBase Plugin](./trino-oceanbase-plugin/README.md) |
| WordPress OceanBase Plugin | [WordPress OceanBase Plugin](./wordpress-oceanbase-plugin/README.md) |
| OceanBase SQL Helper Plugin | [OceanBase SQL Helper Plugin](./oceanbase-sql-helper-plugin/README.md) |
| Metabase OceanBase Plugin | [Metabase OceanBase Plugin](./metabase-oceanbase-plugin/README.md) |
| OceanBase SQLAlchemy Plugin | [OceanBase SQLAlchemy Plugin](./oceanbase-sqlalchemy-plugin/README.md) |
| OceanBase Dify Plugin | [OceanBase Dify Plugin](./dify-plugin-oceanbase/README.md) |
| LangGraph Checkpoint OceanBase Plugin | [LangGraph Checkpoint OceanBase Plugin](./langgraph-checkpoint-oceanbase-plugin/README.md) |
---
## 🛠️ Contributing & Feedback
We welcome contributions via **Issues** or **Pull Requests**.
For questions or suggestions, visit [GitHub Issues](https://github.com/oceanbase/ecology-plugins/issues).
---
## 📄 License
This project is licensed under the [Apache License 2.0](./LICENSE).
---
## 📌 Notes
- For detailed configuration and usage instructions, refer to the respective plugin documentation.
- Ensure OceanBase version compatibility (recommended ≥ 3.1.0).
- Plugins support MySQL/Oracle modes; select the appropriate version based on your environment.