跳到主要内容

seekdb Cursor Extension

在 AI 辅助编程时代，开发者越来越依赖智能 IDE 来提高开发效率。然而，当使用特定技术栈（如 seekdb 向量数据库）时，AI 助手往往缺乏相关领域知识，无法提供精准的代码建议和帮助。为了解决这一问题，OceanBase 提供了 seekdb Cursor Extension，它一个为 Cursor 编辑器设计的扩展插件，能够将 seekdb 官方文档集成到 Cursor AI 助手中，使其具备 seekdb 数据库开发的专业知识。

背景信息​

什么是 Cursor？​

Cursor 是一款由 AI 驱动的代码编辑器，支持 Windows、macOS 和 Linux 操作系统。Cursor 内置了强大的 AI 助手，能够帮助开发者：

  • 智能代码补全：根据上下文自动补全代码。
  • 代码生成：通过自然语言描述生成代码。
  • 代码解释与重构：理解和优化现有代码。
  • 问答交互：直接与 AI 对话解决编程问题。

通过 .cursor/rules 目录，开发者可以为 AI 助手提供额外的知识和规则，使其更好地理解特定技术栈。有关 Cursor 规则的更多信息，请参见 Cursor 规则文档。

seekdb Cursor Extension 介绍​

seekdb Cursor Extension 是一个 Cursor 编辑器扩展，它通过配置 Cursor Rules 让 AI 助手具备访问 seekdb 官方文档的能力，使其能够：

  • 理解 seekdb 数据库概念：向量搜索、混合搜索、AI 函数等
  • 提供准确的代码建议：基于官方文档生成符合最佳实践的代码
  • 回答 seekdb 相关问题：直接在编辑器中获取技术支持
  • 加速开发流程：减少查阅文档的时间，专注于业务逻辑

核心组件​

文件/目录说明
.cursor/rules/seekdb.mdcAI 助手行为规则文件，定义了两层访问策略和文档引用规范
.cursor/rules/seekdb-docs/本地文档缓存目录，作为 GitHub 不可访问时的备用数据源

当您安装并启用扩展后，它会将 seekdb.mdc 规则文件和完整的 seekdb 文档复制到您项目的 .cursor/rules 目录中。AI 助手会优先从 GitHub 获取最新文档；如果网络不可用，则自动切换到本地文档，确保您始终能够获得帮助。

安装插件​

从 Cursor 扩展市场安装，具体步骤如下：

  1. 打开 Cursor 编辑器。

  2. 点击左侧边栏上方的扩展图标，或使用快捷键：

    • Windows/Linux: Ctrl+Shift+X
    • macOS: Cmd+Shift+X

  3. 在搜索框中输入 "seekdb"。

  4. 找到 "seekdb" 扩展，点击Install按钮。

主要功能​

一键添加 seekdb 文档​

通过简单的命令，即可将 seekdb 官方文档添加到当前项目：

操作步骤：

  1. 打开命令面板：

    • Windows/Linux: 按 Ctrl+Shift+P
    • macOS: 按 Cmd+Shift+P

  2. 输入 "seekdb Docs" 或 "Add seekdb Docs"

  3. 选择 Add seekdb Docs 命令

文档将自动添加到：

  • .cursor/rules/seekdb-docs 目录（官方文档）
  • .cursor/rules/seekdb.mdc 文件（AI 规则文件）

双模式文档访问​

扩展支持两种工作模式，并具有自动切换功能：

模式触发条件文档来源引用格式
远程模式（主要）GitHub 可访问从 GitHub 实时获取最新文档GitHub 链接
本地模式（备用）网络超时/错误/不可达从本地 .cursor/rules/seekdb-docs/ 读取本地路径

工作流程​

  1. AI 助手首先尝试通过 curl 从 GitHub 获取文档目录
  2. 如果成功返回 markdown 内容 → 使用远程模式
  3. 如果超时、错误或返回空内容 → 立即切换到本地模式
  4. 一旦切换到本地模式，同一对话中不再尝试远程访问

版本管理​

  • 自动检测文档版本
  • 仅在文档版本更新时重新复制

一键移除文档​

如果不再需要 seekdb 文档，可以轻松移除：

  1. 打开命令面板（Ctrl+Shift+P 或 Cmd+Shift+P）。
  2. 输入 "Remove seekdb Docs"。
  3. 选择 Remove seekdb Docs 命令。

使用场景​

场景 1：快速学习 seekdb​

当您刚开始接触 seekdb 时，可以直接在 Cursor 中提问：

用户：如何在 seekdb 中创建向量索引？ AI 助手： 根据 seekdb 文档，您可以使用以下 SQL 创建 HNSW 向量索引...

场景 2：编写向量搜索代码​

在编写代码时，AI 助手能够基于文档提供准确的代码示例：

用户： 编写在 seekdb 中进行混合搜索的代码。 AI 助手：

import pyseekdb

# 连接 seekdb
client = pyseekdb.Client(...)
# 拿到 collection
collection = client.get_collection("...")
# 进行混合搜索
results = collection.hybrid_search(
   query={
       "where_document": {"$contains": "..."},
       "where": {"category": {"$eq": "..."}},
       "n_results": 10
   },
   knn={
       "query_texts": ["..."],  # Will be embedded automatically
       "where": {"year": {"$gte": ...}},
       "n_results": 10
   },
   rank={"rrf": {}},  # Reciprocal Rank Fusion
   n_results=5,
   include=["documents", "metadatas", "embeddings"]
)

场景 3：调试和问题排查​

遇到问题时，AI 助手可以基于官方文档提供解决方案：

用户： 我的向量搜索返回结果不准确，可能是什么原因？ AI 助手： 根据 seekdb 文档，常见原因包括...（提供具体的排查步骤和解决方案）

总结​

seekdb Cursor Extension 是连接 seekdb 与 Cursor AI 助手的桥梁，让开发者能够在编写代码时获得 seekdb 专业知识的支持。无论您是刚开始学习 seekdb，还是正在开发生产级 AI 应用，这个扩展都能显著提升您的开发效率。

Contents

编辑此页