Back to Details

seekdb-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

seekdb Documentation

seekdb 文档

Provides access to ~1000 seekdb documentation entries through a catalog-based search system.
通过基于目录的搜索系统提供对约1000条seekdb文档条目的访问权限。

Version Info

版本信息

<!-- AUTO-UPDATED by update_docs.sh — do not edit manually -->
  • Documentation versions covered: V1.0.0, V1.1.0 (merged, latest takes priority)
  • Latest version: V1.1.0
<!-- END AUTO-UPDATED -->
  • The 
    branch
    field in catalog entries indicates which Git branch hosts the file (used for remote fallback URLs only). It does NOT indicate which seekdb version the content applies to — many docs apply to all versions.
  • If the user asks about a specific seekdb version, note that this documentation set reflects the latest available content and may not distinguish version-specific differences.
<!-- AUTO-UPDATED by update_docs.sh — do not edit manually -->
  • 涵盖的文档版本：V1.0.0、V1.1.0（已合并，最新版本优先）
  • 最新版本：V1.1.0
<!-- END AUTO-UPDATED -->
  • 目录条目中的
    branch
    字段表示托管文件的Git分支（仅用于远程备用URL）。它不表示内容适用的seekdb版本——许多文档适用于所有版本。
  • 如果用户询问特定的seekdb版本，请注意此文档集反映的是最新可用内容，可能无法区分版本特定的差异。

Path Resolution (Do First)

路径解析（优先执行）

All resource paths are relative to this SKILL.md's location. Resolve the skill directory first:
  1. Read this SKILL.md to get its absolute path
  2. Extract the parent directory as 
    <skill_dir>
  3. Catalog: 
    <skill_dir>references/seekdb-docs-catalog.jsonl
  4. Docs base: 
    <skill_dir>seekdb-docs/
所有资源路径均相对于此SKILL.md的位置。请先解析技能目录：
  1. 读取此SKILL.md以获取其绝对路径
  2. 提取父目录作为
    <skill_dir>
  3. 目录：
    <skill_dir>references/seekdb-docs-catalog.jsonl
  4. 文档基础路径：
    <skill_dir>seekdb-docs/

Workflow

工作流程

Step 1: Search Catalog

步骤1：搜索目录

Grep search (preferred for ~90% of queries):
bash
grep -i "keyword" <skill_dir>references/seekdb-docs-catalog.jsonl
Full catalog load (only when grep returns no results or semantic matching is needed):
  • Local: 
    <skill_dir>references/seekdb-docs-catalog.jsonl
  • Remote fallback: 
    https://raw.githubusercontent.com/oceanbase/seekdb-ecology-plugins/main/agent-skills/skills/seekdb/references/seekdb-docs-catalog.jsonl
  • Format: JSONL — one 
    {"path": "...", "description": "...", "branch": "..."}
    per line (~1000 entries)
Grep搜索（约90%的查询首选）：
bash
grep -i "keyword" <skill_dir>references/seekdb-docs-catalog.jsonl
完整目录加载（仅当grep无结果或需要语义匹配时使用）：
  • 本地路径：
    <skill_dir>references/seekdb-docs-catalog.jsonl
  • 远程备用路径：
    https://raw.githubusercontent.com/oceanbase/seekdb-ecology-plugins/main/agent-skills/skills/seekdb/references/seekdb-docs-catalog.jsonl
  • 格式：JSONL — 每行一条
    {"path": "...", "description": "...", "branch": "..."}
    （约1000条条目）

Step 2: Match Query

步骤2：匹配查询

  • Extract 
    path
    , 
    description
    , and 
    branch
    from search results
  • Select entries whose descriptions best match the query semantically (match by meaning, not just keywords)
  • Consider multiple matches for comprehensive answers
  • 从搜索结果中提取
    path
    、
    description
    和
    branch
  • 选择描述在语义上与查询最匹配的条目（按含义匹配，而非仅关键词）
  • 考虑多个匹配项以获取全面的答案

Step 3: Read Document

步骤3：读取文档

Local-first with remote fallback:
  1. Try local: 
    <skill_dir>seekdb-docs/[path]
  2. Fallback: 
    https://raw.githubusercontent.com/oceanbase/seekdb-doc/[branch]/en-US/[path]
    • [branch]
      comes from the catalog entry's 
      branch
      field (e.g. 
      V1.0.0
      , 
      V1.1.0
      )
    • Docs span multiple version branches; some files only exist in a specific branch
优先本地读取，远程作为备用：
  1. 尝试本地路径：
    <skill_dir>seekdb-docs/[path]
  2. 备用路径：
    https://raw.githubusercontent.com/oceanbase/seekdb-doc/[branch]/en-US/[path]
    • [branch]
      来自目录条目的
      branch
      字段（例如
      V1.0.0
      、
      V1.1.0
      ）
    • 文档分布在多个版本分支中；部分文件仅存在于特定分支

Example

示例

Query: "How to integrate with Claude Code?"

1. grep -i "claude code" <skill_dir>references/seekdb-docs-catalog.jsonl
2. Match: {"path": "300.integrations/300.developer-tools/700.claude-code.md",
           "description": "This guide explains how to use the seekdb plugin with Claude Code...",
           "branch": "V1.0.0"}
3. Read: <skill_dir>seekdb-docs/300.integrations/300.developer-tools/700.claude-code.md
   Fallback: https://raw.githubusercontent.com/oceanbase/seekdb-doc/V1.0.0/en-US/300.integrations/300.developer-tools/700.claude-code.md
See examples.md for more complete workflow examples.
查询："如何与Claude Code集成？"

1. grep -i "claude code" <skill_dir>references/seekdb-docs-catalog.jsonl
2. 匹配结果：{"path": "300.integrations/300.developer-tools/700.claude-code.md",
           "description": "This guide explains how to use the seekdb plugin with Claude Code...",
           "branch": "V1.0.0"}
3. 读取路径：<skill_dir>seekdb-docs/300.integrations/300.developer-tools/700.claude-code.md
   备用路径：https://raw.githubusercontent.com/oceanbase/seekdb-doc/V1.0.0/en-US/300.integrations/300.developer-tools/700.claude-code.md
查看examples.md获取更完整的工作流程示例。

Notes

注意事项

  • Optional local docs: Run 
    scripts/update_docs.sh
    to download and merge docs from all version branches locally
  • Multi-version: Docs span multiple branches; the update script merges them and records each file's source branch in the catalog
  • Offline capable: With local docs and catalog present, works completely offline
  • 可选本地文档：运行
    scripts/update_docs.sh
    可从所有版本分支下载并合并本地文档
  • 多版本支持：文档分布在多个分支中；更新脚本会合并它们，并在目录中记录每个文件的源分支
  • 离线可用：若本地存在文档和目录，可完全离线使用

Category Overview

分类概述

  • Get Started: Quick start, basic operations, overview
  • Development: Vector search, hybrid search, AI functions, MCP, multi-model
  • Integrations: Frameworks, model platforms, developer tools, workflows
  • Guides: Deployment, management, security, OBShell, performance
  • Reference: SQL syntax, PL, error codes, SDK APIs
  • Tutorials: Step-by-step scenarios
  • 入门指南：快速开始、基础操作、概述
  • 开发：向量搜索、混合搜索、AI函数、MCP、多模型
  • 集成：框架、模型平台、开发者工具、工作流
  • 指南：部署、管理、安全、OBShell、性能
  • 参考：SQL语法、PL、错误代码、SDK API
  • 教程：分步场景