Skip to content

oceanbase/quickstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 

OceanBase Developer Quickstart 🧭

中文版本

This developer-oriented guideline helps you pick the right SDKs, plugins, demos or applications to build practical applications on OceanBase. Each entry highlights typical use cases and key capabilities so you can choose quickly.

We welcome contributions and feedback. If you have a project to add or ideas to improve this index, please open an issue or a PR.

Overview 🧾

Applicaiton or Demo Projects 🧪

Demos are the fastest way to validate capabilities and bootstrap a PoC or prototype.

Project Use Case Key Features
TravelAssist Travel AI Agent Travel AI Agent, show how to use AI hybrid search and GIS capacities on OceanBase or OceanBase seekdb.
ChatBot ChatBot & RAG ChatBot, show how to implement a RAG based on OceanBase or OceanBase seekdb AI capabilities escpecailly hybrid search and AI embedding.
mine-kb Local knowledge base app A local personal knowledge base on SeekDB.
image-search Image similarity search Image search application built with the vector capabilities of OceanBase
ob-samples OceanBase samples and best practices Show how to use OceanBase, providing the sample projects for OceanBase.
oceanbase-demos OceanBase demo collection OceanBase Demos
devcon Developer conference content and demos Demos on OceanBase Developer Conference

SDK Projects 🧩

AI 🤖

Project Use Case Key Features
langchain-oceanbase LangChain integration for OceanBase LangChain integration with OceanBase.
powermem Memory system for AI apps PowerMem: Your AI-Powered Long-Term Memory — Accurate, Agile, Affordable.
pyseekdb New SDK for Python A unified python SDK supports OceanBase or OceanBase seekdb, more efficient and easy-to-use.
pyobvector Old SDK for Python A Python SDK for OceanBase Multimodal Store—enabling vector search, full-text search, and JSON table operations—offers both Milvus-compatible API and SQLAlchemy-based SQL mode, and supports both OceanBase and OceanBase seekdb.
seekdb-js SDK for JavaScript/TypeScript The JavaScript/TypeScript SDK for OceanBase or OceanBase seekdb.
obvec_jdbc Java SDK for AI operation A Java SDK for OceanBase Multimodal Store—enabling vector search, full-text search, and JSON table operations—supports both OceanBase and OceanBase seekdb.
seekdb-rs Rust SDK The Rust SDK for OceanBase or OceanBase seekdb.
seekdb-go Go SDK for AI operation The Go SDK for OceanBase or OceanBase seekdb.

Driver or ORM 🔌

Project Use Case Key Features
OceanBase SQLAlchemy Plugin Python ORM SQLAlchemy ORM for OceanBase Oracle mode, compatible with SQLAlchemy 1.3+ and 2.0+
PyObsql OceanBase Plugin Python SDK A Python SDK for OceanBase SQL mode
ob-connector-odbc ODBC driver for OceanBase An ODBC driver for connecting C applications to OceanBase Database.
obconnector-j JDBC driver for OceanBase OceanBase Client for Java is a JDBC 4.2–compatible driver that enables Java applications to connect to the OceanBase Database Server, supporting OceanBase both MySQL and Oracle compatibility modes.
obconnector-c C client driver for OceanBase OceanBase Client for C is a native driver that enables C applications to connect to the OceanBase Database.
go-oceanbase-driver Go database/sql access to OceanBase Go OceanBase Driver is a OceanBase driver for Go's (golang) database/sql package

KV 🗂️

Project Use Case Key Features
obkv-hbase-client-java OBKV HBase SDK in Java OBKV HBase Client is a Java library that enables access to OceanBase data by the HBase 0.94, 1.x, or 2.x APIs.
obkv-table-client-java OBKV Table SDK in Java The OBKV Table Client is a Java library that provides high-performance access to table and key-value data in OceanBase’s storage layer.
obkv-hbase-client-go OBKV HBase SDK in Go This project is deprecated and no longer recommended for new development.
obkv-table-client-go OBKV Table SDK in Go This project is deprecated and no longer recommended for new development.

Applicaiton or Demo Projects 🧪

Demos are the fastest way to validate capabilities and bootstrap a PoC or prototype.

Project Use Case Key Features
image-search Image similarity search Image search application built with the vector capabilities of OceanBase
ob-samples OceanBase samples and best practices Show how to use OceanBase, providing the sample projects for OceanBase.
ob-multi-model-search-demo Multimodal search demo
oceanbase-demos OceanBase demo collection OceanBase Demos
devcon Developer conference content and demos
ai-workshop-2024 RAG workshop and tutorial AI Workshop Project of OceanBase 2024 Product Launch
mine-kb Local knowledge base app A local personal knowledge base on SeekDB.

Plugin Projects 🔌

Plugins bring OceanBase/SeekDB capabilities into the developer workflow to improve search and documentation usage.

Plugin Name Use Case Key Features
Flyway OceanBase Plugin Database Migration This plugin enables Flyway to support OceanBase in both MySQL and Oracle compatibility modes.
WordPress OceanBase Plugin Content Management This plugin enables WordPress to support OceanBase in both MySQL modes.
Metabase OceanBase Plugin Data Visualization This plugin enables Metabase to support OceanBase in both MySQL and Oracle compatibility modes.
LangGraph Checkpoint OceanBase Plugin LangGraph CheckpointSaver Implementation of LangGraph CheckpointSaver in OceanBase MySQL mode
spark-connector-oceanbase Data ingestion with Spark Apache Spark Connectors for OceanBase.
flink-connector-oceanbase Streaming ingestion with Flink Apache Flink Connectors for OceanBase.
kafka-connect-oceanbase Kafka Connect integration kafka-connect-oceanbase is a Kafka Connector that enables bidirectional data transfer between Apache Kafka and OceanBase, supporting both MySQL and Oracle compatibility modes.
trino-oceanbase Trino query engine integration Enables Trino to connect to OceanBase (MySQL/Oracle mode)
OceanBase SQL Helper Plugin Development Tools A VSCode extension that helps developers quickly find OceanBase SQL keywords documentation.
seekdb Claude Code Plugin Development Tools This plugin contains seekdb skill that is designed specifically for Claude Code, aimed at enhancing Claude's capabilities in seekdb database scenarios.
seekdb Cursor Extension Development Tools Provide Agent plugin support for seekdb, facilitating developers' use of the seekdb database within the Agent APP.

Dify 🧠

Project Use Case Key Features
dify-on-mysql Dify deployment on OceanBase MySQL mode This is a branch for Dify, which provides several enhancements for Dify by replacing all storage components with OceanBase and introducing numerous enterprise features: High availability Scalable performance improvement Multi-tenancy support through OceanBase
dify-plugin-powermem Dify memory integration Dify plugin for powermem
dify-plugin-oceanbase Dify OceanBase connector A Dify plugin that connects to and queries OceanBase.
dify-plugin-daemon Dify plugin runtime

MCP Resources 🧰

Model Context Protocol (MCP) integrations help AI tools and agents connect to OceanBase/SeekDB data and capabilities. If you have MCP servers, clients, or example integrations, please contribute them here so others can reuse them.

awesome-oceanbase-mcp

🔧 MCP Server 📝 Description 📚 Documentation
OceanBase MCP Server Provides secure interaction capabilities with OceanBase databases, supporting SQL queries, data management operations 📖 View
OCP MCP Server Integrates with OceanBase Cloud Platform, providing cluster management and monitoring capabilities 📖 View
OBCloud MCP Server Connects to OBCloud services, providing cloud database management functionality 📖 View
OKCTL MCP Server Manages OceanBase resources and deployments in Kubernetes environments 📖 View
OBDIAG MCP Server Provides OceanBase diagnostic tool integration, supporting performance analysis and troubleshooting 📖 View
obshell MCP Server Enables OceanBase cluster creation, deployment and operations management through obshell 📖 View
seekdb MCP Server Provides vector operations, collection management, SQL queries and AI functions for seekdb database 📖 View
PowerMem MCP Server Provides AI memory management capabilities, supporting memory storage, search, and intelligent retrieval with Ebbinghaus forgetting curve 📖 View

Contributing 🤝

We welcome SDKs, plugins, demos, tutorials, and real-world case studies. Please submit a PR with a short description of the use case and the key capabilities it demonstrates.

Community & Support 💬

Releases

No releases published

Packages

No packages published