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.
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 | Database Migration | Resolves compatibility issues when using Flyway with OceanBase in MySQL mode |
| Trino OceanBase Plugin | Data Analysis | Enables Trino to connect to OceanBase (MySQL/Oracle mode) |
| WordPress OceanBase Plugin | Content Management | Fixes compatibility issues between WordPress and OceanBase MySQL tenants |
| OceanBase SQL Helper Plugin | Development Tools | VSCode extension for quick access to OceanBase SQL keywords documentation |
| Metabase OceanBase Plugin | Data Visualization | Enables Metabase to connect to OceanBase (MySQL/Oracle mode) |
| OceanBase SQLAlchemy Plugin | Python ORM | SQLAlchemy dialect for OceanBase Oracle mode, compatible with SQLAlchemy 1.3+ and 2.0+ |
| OceanBase Dify Plugin | AI Applications | Enables secure SQL query execution on OceanBase databases through Dify applications |
| LangGraph Checkpoint OceanBase Plugin | LangGraph CheckpointSaver | Implementation of LangGraph CheckpointSaver that uses OceanBase MySQL mode |
- Function: Resolves compatibility issues when using Flyway with OceanBase in MySQL mode (e.g.,
versioncolumn conflicts, driver compatibility). - Use Case: Managing database migrations for OceanBase MySQL mode using Flyway.
- Documentation: Flyway 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
- 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
- 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
- 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
- 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
- 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
- Repository: https://github.com/oceanbase/dify-plugin-oceanbase
- 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
| Plugin Name | Documentation Link |
|---|---|
| Flyway OceanBase Plugin | Flyway OceanBase Plugin |
| Trino OceanBase Plugin | Trino OceanBase Plugin |
| WordPress OceanBase Plugin | WordPress OceanBase Plugin |
| OceanBase SQL Helper Plugin | OceanBase SQL Helper Plugin |
| Metabase OceanBase Plugin | Metabase OceanBase Plugin |
| OceanBase SQLAlchemy Plugin | OceanBase SQLAlchemy Plugin |
| OceanBase Dify Plugin | OceanBase Dify Plugin |
| LangGraph Checkpoint OceanBase Plugin | LangGraph Checkpoint OceanBase Plugin |
We welcome contributions via Issues or Pull Requests. For questions or suggestions, visit GitHub Issues.
This project is licensed under the Apache License 2.0.
- 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.