Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ OceanBase is a high-performance database compatible with both MySQL and Oracle p
| [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](./oceanbase-dify-plugins/README.md) | AI Applications | Enables secure SQL query execution on OceanBase databases through Dify applications |
| [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|

---
Expand Down Expand Up @@ -73,9 +73,10 @@ OceanBase is a high-performance database compatible with both MySQL and Oracle p

### ✅ OceanBase Dify Plugin

- **Function**: A simple OceanBase database plugin that enables secure SQL query execution on OceanBase databases through Dify applications with comprehensive error handling and result formatting.
- **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](./oceanbase-dify-plugins/README.md)
- **Documentation**: [OceanBase Dify Plugin](./dify-plugin-oceanbase/README.md)
- **New Repository**: https://github.com/oceanbase/dify-plugin-oceanbase

---

Expand All @@ -99,7 +100,7 @@ OceanBase is a high-performance database compatible with both MySQL and Oracle p
| 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](./oceanbase-dify-plugins/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) |

---
Expand Down
9 changes: 5 additions & 4 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ OceanBase 是一款兼容 MySQL 和 Oracle 协议的高性能数据库。本仓
| [Metabase OceanBase 插件](./metabase-oceanbase-plugin/README_CN.md) | 数据可视化 | 支持 Metabase 连接 OceanBase(MySQL/Oracle 模式) |
| [OceanBase SQLAlchemy 插件](./oceanbase-sqlalchemy-plugin/README.md) | Python ORM | SQLAlchemy 方言,支持 OceanBase Oracle 模式,兼容 SQLAlchemy 1.3+ 和 2.0+ |
| [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README.md) | 保存 LangGraph 的 checkpoint | 使用 OceanBase MySQL 模式实现了 LangGraph CheckpointSaver |
| [OceanBase Dify 插件](./oceanbase-dify-plugins/README_CN.md) | AI 应用 | 通过 Dify 应用程序在 OceanBase 数据库上安全执行 SQL 查询 |
| [OceanBase Dify 插件](./dify-plugin-oceanbase/README_CN.md) | AI 应用 | 通过 Dify 应用程序在 OceanBase 数据库上安全执行 SQL 查询 |
| [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README_CN.md) | 保存 LangGraph 的 checkpoint | 使用 OceanBase MySQL 模式实现了 LangGraph CheckpointSaver |
------

Expand Down Expand Up @@ -83,9 +83,10 @@ OceanBase 是一款兼容 MySQL 和 Oracle 协议的高性能数据库。本仓

### ✅ OceanBase Dify 插件

- **功能**:一个简单的 OceanBase 数据库插件,通过 Dify 应用程序在 OceanBase 数据库上安全执行 SQL 查询,具有全面的错误处理和结果格式化功能
- **功能**:用于连接和查询 OceanBase 数据库的 Dify 插件。此项目已迁移到新仓库
- **适用场景**:需要通过 Dify 平台与 OceanBase 数据库交互进行数据查询和操作的 AI 应用程序。
- **详细文档**:[OceanBase Dify 插件](./oceanbase-dify-plugins/README_CN.md)
- **详细文档**:[OceanBase Dify 插件](./dify-plugin-oceanbase/README_CN.md)
- **新仓库地址**:https://github.com/oceanbase/dify-plugin-oceanbase

------

Expand All @@ -109,7 +110,7 @@ OceanBase 是一款兼容 MySQL 和 Oracle 协议的高性能数据库。本仓
| Metabase OceanBase 插件 | [Metabase OceanBase 插件](./metabase-oceanbase-plugin/README_CN.md) |
| OceanBase SQLAlchemy 插件 | [OceanBase SQLAlchemy 插件](./oceanbase-sqlalchemy-plugin/README.md) |
| LangGraph Checkpoint OceanBase 插件 | [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README.md) |
| OceanBase Dify 插件 | [OceanBase Dify 插件](./oceanbase-dify-plugins/README_CN.md) |
| OceanBase Dify 插件 | [OceanBase Dify 插件](./dify-plugin-oceanbase/README_CN.md) |
| LangGraph Checkpoint OceanBase 插件 | [LangGraph Checkpoint OceanBase 插件](./langgraph-checkpoint-oceanbase-plugin/README_CN.md) |

------
Expand Down
61 changes: 61 additions & 0 deletions dify-plugin-oceanbase/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# OceanBase Dify Plugin

> **Note**: This project has been migrated to a new repository. Please use the new repository address.

## 🔗 Repository Address

**GitHub**: https://github.com/oceanbase/dify-plugin-oceanbase

## 📖 Project Description

This is a Dify plugin for connecting to and querying OceanBase databases.

## 🌟 Features

### Tools Introduction

#### 1. Execute SQL

- **Function**: Execute SQL queries on existing OceanBase databases
- **Usage**: Directly execute SQL statements starting with SELECT, SHOW, or WITH
- **Output Format**: Supports multiple formats including JSON, CSV, YAML, Markdown, Excel, HTML, etc.
- **Security Restrictions**: Only supports query statements to ensure database security

#### 2. Get Table Schema

- **Function**: Get table structure information from the database
- **Usage**: Provide database context for LLM to help understand table structure
- **Flexibility**: Can specify specific tables or get structure information for all tables
- **Use Cases**: Understand database structure before generating SQL queries

#### 3. Text to SQL

- **Function**: Use LLM to convert natural language queries into SQL statements
- **Usage**: Allow users to describe query requirements in natural language and automatically generate corresponding SQL
- **Intelligence**: Generate accurate SQL based on database context and table structure information
- **Model Selection**: Support selecting different large language models for conversion

## 🚀 Usage Instructions

1. **Database Connection**: Configure OceanBase database connection information
2. **Select Tools**: Choose appropriate tools based on requirements
3. **Execute Queries**: Query data through natural language or direct SQL
4. **Get Results**: Obtain query results in specified format

## ⚠️ Notes

- This plugin only supports query operations and does not support data modification
- It is recommended to use read-only database accounts to ensure security
- Supports multiple output formats that can be selected as needed

## 📝 License

This project is licensed under the Apache-2.0 License.

## 🤝 Contributing

Please visit the repository to contribute: https://github.com/oceanbase/dify-plugin-oceanbase

## 📞 Support

For issues and questions, please submit an Issue in the repository: https://github.com/oceanbase/dify-plugin-oceanbase/issues
61 changes: 61 additions & 0 deletions dify-plugin-oceanbase/README_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# OceanBase Dify 插件

> **注意**: 此项目已迁移到新的仓库。请使用新的仓库地址。

## 🔗 仓库地址

**GitHub**: https://github.com/oceanbase/dify-plugin-oceanbase

## 📖 项目描述

这是一个用于连接和查询 OceanBase 数据库的 Dify 插件。

## 🌟 功能特性

### 工具介绍

#### 1. 执行 SQL

- **功能**: 在现有 OceanBase 数据库上执行 SQL 查询
- **用法**: 直接执行以 SELECT、SHOW 或 WITH 开头的 SQL 语句
- **输出格式**: 支持多种格式,包括 JSON、CSV、YAML、Markdown、Excel、HTML 等
- **安全限制**: 仅支持查询语句,确保数据库安全

#### 2. 获取表结构

- **功能**: 从数据库获取表结构信息
- **用法**: 为 LLM 提供数据库上下文,帮助理解表结构
- **灵活性**: 可以指定特定表或获取所有表的结构信息
- **用例**: 在生成 SQL 查询前了解数据库结构

#### 3. 文本转 SQL

- **功能**: 使用 LLM 将自然语言查询转换为 SQL 语句
- **用法**: 允许用户用自然语言描述查询需求,自动生成相应的 SQL
- **智能性**: 基于数据库上下文和表结构信息生成准确的 SQL
- **模型选择**: 支持选择不同的大语言模型进行转换

## 🚀 使用说明

1. **数据库连接**: 配置 OceanBase 数据库连接信息
2. **选择工具**: 根据需求选择合适的工具
3. **执行查询**: 通过自然语言或直接 SQL 查询数据
4. **获取结果**: 以指定格式获取查询结果

## ⚠️ 注意事项

- 此插件仅支持查询操作,不支持数据修改
- 建议使用只读数据库账户以确保安全
- 支持多种输出格式,可根据需要选择

## 📝 许可证

本项目采用 Apache-2.0 许可证。

## 🤝 贡献

请访问仓库进行贡献:https://github.com/oceanbase/dify-plugin-oceanbase

## 📞 支持

如有问题,请在新仓库中提交 Issue:https://github.com/oceanbase/dify-plugin-oceanbase/issues
143 changes: 0 additions & 143 deletions oceanbase-dify-plugins/.github/workflows/plugin-publish.yml

This file was deleted.

50 changes: 0 additions & 50 deletions oceanbase-dify-plugins/.gitignore

This file was deleted.

Loading
Loading