seekdb documentation catalog

This catalog provides a comprehensive index of all seekdb documentation. When users ask about seekdb-related topics, you can use the descriptions to find relevant documents and fetch the content from the specified URLs.

Base URL: https://raw.githubusercontent.com/oceanbase/seekdb-doc/V1.0.0/en-US/

tip

All File Paths below are relative paths. The full URL = Base URL + File Path

---

Documentation Overview

• File Path: 10.doc-overview.md

  • Description: seekdb documentation overview, including quick links to get started guides, SDK references, integrations, and tutorials

---

Get Started

This category contains quick start tutorials and basic operation guides for the seekdb database.

Summary

This category contains documentation files covering seekdb quick start, basic operations, and deployment guides.

Seekdb Overview

• File Path: 100.get-started/10.overview/10.seekdb-overview.md

  • Description: Introduction to what seekdb is - an AI-native search database that unifies relational, vector, text, JSON and GIS in a single engine, enabling hybrid search and in-database AI workflows. Includes capability matrix, product architecture, core advantages, and applicable scenarios like RAG, AI-assisted programming, semantic search, and agentic AI applications.

Embedded Mode

• File Path: 100.get-started/50.use-seekdb-with-sdk/25.using-seekdb-in-python-sdk.md

  • Description: How to use seekdb in embedded mode with Python SDK (pyseekdb). Covers installation, prerequisites, and basic usage examples including connecting to seekdb, creating collections with embedding functions, adding data, and querying with automatic vector generation.

Client-Server Mode

• File Path: 100.get-started/100.use-seekdb-with-sql/10.deploy-seekdb-testing-environment.md

  • Description: Quick deployment guide for seekdb in client/server mode using yum install or Docker containers. Includes prerequisites, system requirements, and step-by-step deployment instructions.

---

Development Guide

This category contains detailed development guides for seekdb features including vector search, hybrid search, AI functions, SDK, and multi-model data support.

Vector Search

Vector Search Overview

• File Path: 200.develop/100.vector-search/100.vector-search-overview/100.vector-search-intro.md

  • Description: Comprehensive overview of vector search concepts including unstructured data, vectors, vector embedding, vector similarity search, and why choose seekdb for vector search (hybrid retrieval, scalability, high performance, transactions, cost efficiency, data security).

• File Path: 200.develop/100.vector-search/100.vector-search-overview/300.vector-search-workflow.md

  • Description: AI application workflow using seekdb vector search, from converting unstructured data to vectors, storing embeddings and creating indexes, performing nearest neighbor and hybrid search, to generating prompts for LLM inference.

Vector Embedding

• File Path: 200.develop/100.vector-search/150.vector-embedding-technology.md

  • Description: Vector embedding technology guide covering what vector embedding is, generating embeddings using AI function service in seekdb, common text embedding methods (Sentence Transformers, Hugging Face, Ollama), and image embedding with CLIP.

Store Vector Data

• File Path: 200.develop/100.vector-search/160.store-vector-data.md

  • Description: How to store vector data in seekdb including creating vector columns with VECTOR data type, and inserting vector data using INSERT statements.

Vector Indexes

• File Path: 200.develop/100.vector-search/200.vector-index/200.dense-vector-index.md

  • Description: Comprehensive guide to dense vector indexes including index types (HNSW, HNSW_SQ, HNSW_BQ, IVF, IVF_PQ, IVF_SQ), memory estimation, creation syntax, maintenance operations, and query examples.

• File Path: 200.develop/100.vector-search/200.vector-index/300.hybrid-vector-index.md

  • Description: Guide to creating hybrid vector indexes that automatically embed text. Covers synchronous and asynchronous modes, creation syntax, prerequisites for registering embedding models, and using semantic_distance function.

• File Path: 200.develop/100.vector-search/200.vector-index/400.sparse-vector-index/100.in-memory-sparse-vector-index.md

  • Description: Guide to in-memory sparse vector indexes for sparse vector data.

Vector Functions

• File Path: 200.develop/100.vector-search/250.vector-function.md

  • Description: SQL functions for vector operations including distance functions (L2_distance, Cosine_distance, Inner_product), vector arithmetic functions, and normalization functions.

Vector Similarity Search

• File Path: 200.develop/100.vector-search/300.vector-similarity-search.md

  • Description: Vector similarity search guide covering exact nearest neighbor search (full-scan) and approximate nearest neighbor search using vector indexes. Includes examples for Euclidean, cosine, and inner product similarity search.

Vector Search Reference

• File Path: 200.develop/100.vector-search/700.vector-search-reference/100.vector-data-type.md

  • Description: Reference for vector data types in seekdb.

• File Path: 200.develop/100.vector-search/700.vector-search-reference/800.vector-sdk-refer.md

  • Description: Reference for vector SDK usage.

• File Path: 200.develop/100.vector-search/700.vector-search-reference/900.vector-search-supported-clients-and-languages/100.vector-search-supported-clients-and-languages-overview.md

  • Description: Overview of supported clients and languages for vector search, including MySQL client, Python SDK (3.9+), and Java SDK (1.8).

• File Path: 200.develop/100.vector-search/700.vector-search-reference/900.vector-search-supported-clients-and-languages/200.vector-pyobvector.md

  • Description: Guide to using pyobvector Python library for vector operations.

• File Path: 200.develop/100.vector-search/700.vector-search-reference/900.vector-search-supported-clients-and-languages/300.vector-search-java-sdk.md

  • Description: Guide to using Java SDK for vector search operations.

Benchmark and FAQ

• File Path: 200.develop/100.vector-search/700.vector-search-benchmark-test.md

  • Description: Guide to benchmark testing with VectorDBBench, including prerequisites, installation, configuration, and running performance tests on seekdb vector database.

• File Path: 200.develop/100.vector-search/800.vector-search-faq.md

  • Description: Frequently asked questions about vector search including data dimensionality requirements, maximum rows, and creating indexes on high-dimensional vectors.

Hybrid Search

• File Path: 200.develop/200.hybrid-search/100.vector-index-hybrid-search.md

  • Description: Comprehensive guide to hybrid search with full-text indexes and vector indexes using DBMS_HYBRID_SEARCH package. Covers use cases including scalar search, vector search, full-text search, and various combinations with filtering and sorting.

AI Function

• File Path: 200.develop/300.ai-function/100.ai-function-permission.md

  • Description: AI function privileges guide covering CREATE/ALTER/DROP AI MODEL privileges and ACCESS AI MODEL privileges for calling AI functions.

• File Path: 200.develop/300.ai-function/200.ai-function.md

  • Description: Comprehensive guide to AI functions including AI model management with DBMS_AI_SERVICE package, monitoring AI model usage through views, and AI function expressions (AI_COMPLETE, AI_PROMPT, AI_EMBED, AI_RERANK) with detailed syntax and examples.

MCP Server

• File Path: 200.develop/400.mcp-server/400.oceanbase-mcp-server-and-ai-tool-integration-guide.md

  • Description: OceanBase MCP Server guide for integrating AI tools with databases. Covers the core toolkit (execute_sql, get_ob_ash_report, vector/text/hybrid search, AI memory system tools), resource endpoints, and integration with Cursor and other MCP-compatible tools.

Multi-Model Data

JSON

• File Path: 200.develop/500.multi-model/100.json/100.json-formatted-data-types.md

  • Description: JSON formatted data types in seekdb.

• File Path: 200.develop/500.multi-model/100.json/200.create-a-json-value.md

  • Description: How to create JSON values in seekdb.

• File Path: 200.develop/500.multi-model/100.json/300.querying-and-modifying-json-values.md

  • Description: Querying and modifying JSON values in seekdb.

• File Path: 200.develop/500.multi-model/100.json/400.json-formatted-data-type-conversion.md

  • Description: JSON data type conversion in seekdb.

• File Path: 200.develop/500.multi-model/100.json/500.json-partial-update.md

  • Description: JSON partial update operations in seekdb.

• File Path: 200.develop/500.multi-model/100.json/600.json-semi-struct.md

  • Description: JSON semi-structured data handling in seekdb.

Spatial Data

• File Path: 200.develop/500.multi-model/200.spatial/100.spatial-data-type-overview.md

  • Description: Overview of spatial data types in seekdb for GIS applications.

• File Path: 200.develop/500.multi-model/200.spatial/200.spacial-reference-system.md

  • Description: Spatial reference systems in seekdb.

• File Path: 200.develop/500.multi-model/200.spatial/300.create-spatial-columns.md

  • Description: How to create spatial columns in seekdb.

• File Path: 200.develop/500.multi-model/200.spatial/400.create-spatial-indexes.md

  • Description: How to create spatial indexes in seekdb.

• File Path: 200.develop/500.multi-model/200.spatial/500.spatial-data-format.md

  • Description: Spatial data formats supported in seekdb.

Character and Text

• File Path: 200.develop/500.multi-model/300.char-and-text/100.char-and-varchar.md

  • Description: CHAR and VARCHAR data types in seekdb.

• File Path: 200.develop/500.multi-model/300.char-and-text/200.text.md

  • Description: TEXT data type in seekdb.

• File Path: 200.develop/500.multi-model/300.char-and-text/300.full-text-index.md

  • Description: Full-text index guide for text data in seekdb.

---

Integrations

This category contains guides for integrating seekdb with various AI models, frameworks, developer tools, and workflows.

Framework Integrations

• File Path: 300.integrations/100.frameworks/100.langchain.md

  • Description: Guide to integrating seekdb vector search with LangChain and Qwen API for Document Question Answering (DQA) applications.

• File Path: 300.integrations/100.frameworks/200.llamaindex.md

  • Description: Guide to integrating seekdb vector search with LlamaIndex and Qwen API for context-augmented generative AI applications.

• File Path: 300.integrations/100.frameworks/300.springai.md

  • Description: Guide to integrating seekdb vector search with Spring AI Alibaba for Java AI application development.

Model Platform Integrations

• File Path: 300.integrations/200.model-platforms/100.jina.md

  • Description: Guide to integrating seekdb vector search with Jina AI for multimodal search and RAG applications. Covers prerequisites, obtaining API keys, and building AI assistants.

• File Path: 300.integrations/200.model-platforms/200.openai.md

  • Description: Guide to integrating seekdb with OpenAI API for vector storage and embedding-based search. Covers converting data to vectors using OpenAI API and storing them in seekdb.

• File Path: 300.integrations/200.model-platforms/300.qwen.md

  • Description: Guide to integrating seekdb with Tongyi Qianwen (Qwen) API for vector storage and embedding-based search using DashScope SDK.

• File Path: 300.integrations/200.model-platforms/400.firecrawl.md

  • Description: Guide to integrating seekdb with Firecrawl for building RAG pipelines. Covers web data scraping with Firecrawl, vector storage in seekdb, and generating context-aware responses.

• File Path: 300.integrations/200.model-platforms/500.huggingface.md

  • Description: Guide to integrating seekdb with Hugging Face for vector storage and embedding-based search using pre-trained models and datasets.

• File Path: 300.integrations/200.model-platforms/600.ollama.md

  • Description: Guide to integrating seekdb with Ollama for running local LLMs (gpt-oss, Gemma 3, DeepSeek-R1, Qwen3) and performing embedding-based vector searches.

• File Path: 300.integrations/200.model-platforms/700.google-gemini.md

  • Description: Guide to integrating seekdb with Google Gemini AI for vector storage and multimodal embedding-based search.

• File Path: 300.integrations/200.model-platforms/800.cloudflare-workers-ai.md

  • Description: Guide to integrating seekdb with Cloudflare Workers AI for embedding-based searches using Cloudflare's global network.

Developer Tool Integrations

• File Path: 300.integrations/300.developer-tools/100.cursor.md

  • Description: Guide to integrating OceanBase MCP Server with Cursor IDE for AI-powered database interactions and rapid application development.

• File Path: 300.integrations/300.developer-tools/200.cline.md

  • Description: Guide to integrating OceanBase MCP Server with Cline.

• File Path: 300.integrations/300.developer-tools/300.continue.md

  • Description: Guide to integrating OceanBase MCP Server with Continue.

• File Path: 300.integrations/300.developer-tools/400.trae.md

  • Description: Guide to integrating OceanBase MCP Server with Trae.

• File Path: 300.integrations/300.developer-tools/500.toolbox.md

  • Description: Guide to building OceanBase MCP Server using Google GenAI Toolbox without writing code. Covers setting up Toolbox and creating database tools.

Workflow Integrations

• File Path: 300.integrations/400.workflows/400.dify.md

  • Description: Guide to integrating seekdb vector search with Dify LLM application development platform for building production-ready generative AI applications.

• File Path: 300.integrations/400.workflows/500.n8n.md

  • Description: Guide to integrating seekdb vector search with n8n workflow automation platform to build Chat to seekdb workflows.

Data Ingestion Integrations

• File Path: 300.integrations/500.data-ingestion/100.camel.md

  • Description: Guide to integrating seekdb with CamelAI for natural language queries, intelligent analysis, and data visualization.

MCP Client Integrations

• File Path: 300.integrations/600.mcp/100.augment-code.md

  • Description: Guide to integrating OceanBase MCP Server with Augment Code for AI-powered code understanding, debugging, and feature development.

• File Path: 300.integrations/600.mcp/200.claude-code.md

  • Description: Guide to integrating OceanBase MCP Server with Claude Code, Anthropic's AI-powered terminal coding assistant.

• File Path: 300.integrations/600.mcp/300.kiro.md

  • Description: Guide to integrating OceanBase MCP Server with Kiro, AWS's AI agent IDE for end-to-end development.

---

Guides

This category contains operational guides for deploying, managing, and maintaining seekdb.

Deployment

• File Path: 400.guides/400.deploy/50.deploy-overview.md

  • Description: Deployment overview covering embedded mode (library in application) and server mode (single-machine deployment) with various deployment methods including pyseekdb SDK, Python, yum install, Docker containers, and OceanBase Desktop.

• File Path: 400.guides/400.deploy/100.prepare-servers.md

  • Description: Server preparation guide for seekdb deployment.

Environment and Configuration Checks

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/100.configurations-overview.md

  • Description: Pre-deployment configuration overview including user creation, disk planning, limits.conf, sysctl.conf, and firewall/SELinux settings.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/300.create-regular-user.md

  • Description: Guide to creating a regular user with sudo privileges for seekdb deployment.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/400.plan-disks.md

  • Description: Guide to planning disks for log and data storage directories.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/500.configure-limits-conf.md

  • Description: Guide to configuring limits.conf for seekdb stability and performance.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/600.configure-sysctl-conf.md

  • Description: Guide to configuring sysctl.conf for Linux system performance optimization.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/700.disable-firewall-and-selinux.md

  • Description: Guide to disabling firewall and SELinux for database access.

Embedded Deployment

• File Path: 400.guides/400.deploy/600.python-seekdb.md

  • Description: Embedded deployment mode using Python.

Server Mode Deployment

• File Path: 400.guides/400.deploy/700.server-mode/100.deploy-by-systemd.md

  • Description: Deploy seekdb using yum install with systemd.

• File Path: 400.guides/400.deploy/700.server-mode/200.deploy-by-docker.md

  • Description: Deploy seekdb in a container environment using Docker.

• File Path: 400.guides/400.deploy/700.server-mode/300.deploy-oceanbase-desktop.md

  • Description: Deploy OceanBase Desktop application for managing seekdb.

Management

Configuration Management

• File Path: 400.guides/500.manage/100.configuration-management/100.configuration-management-introduction.md

  • Description: Introduction to configuration management in seekdb, covering configuration items and system variables, their scopes, effective methods, and modification methods.

• File Path: 400.guides/500.manage/100.configuration-management/200.system-configuration-items/100.configuration-items-overview.md

  • Description: Overview of system configuration items in seekdb.

• File Path: 400.guides/500.manage/100.configuration-management/200.system-configuration-items/200.view-parameters.md

  • Description: How to view system parameters in seekdb.

• File Path: 400.guides/500.manage/100.configuration-management/200.system-configuration-items/300.modify-parameters.md

  • Description: How to modify system parameters in seekdb.

• File Path: 400.guides/500.manage/100.configuration-management/200.system-configuration-items/400.reset-parameters.md

  • Description: How to reset system parameters in seekdb.

• File Path: 400.guides/500.manage/100.configuration-management/300.system-variable/100.system-variable-overview.md

  • Description: Overview of system variables in seekdb.

• File Path: 400.guides/500.manage/100.configuration-management/300.system-variable/200.view-system-variables.md

  • Description: How to view system variables in seekdb.

• File Path: 400.guides/500.manage/100.configuration-management/300.system-variable/300.modify-system-variables.md

  • Description: How to modify system variables in seekdb.

High Availability

• File Path: 400.guides/500.manage/200.high-availability/200.recyclebin/100.recyclebin-overview.md

  • Description: Overview of the recycle bin feature in seekdb.

• File Path: 400.guides/500.manage/200.high-availability/200.recyclebin/200.turn-the-recyclebin-on-or-off.md

  • Description: How to turn the recycle bin on or off.

• File Path: 400.guides/500.manage/200.high-availability/200.recyclebin/300.view-the-recyclebin-objects.md

  • Description: How to view objects in the recycle bin.

• File Path: 400.guides/500.manage/200.high-availability/200.recyclebin/400.restore-the-recyclebin-objects.md

  • Description: How to restore objects from the recycle bin.

• File Path: 400.guides/500.manage/200.high-availability/200.recyclebin/500.purge-the-recyclebin.md

  • Description: How to purge the recycle bin.

• File Path: 400.guides/500.manage/200.high-availability/600.flashback-query.md

  • Description: Guide to flashback queries for retrieving historical data using AS OF SNAPSHOT syntax and undo_retention parameter.

Security

• File Path: 400.guides/500.manage/300.security/100.security-overview.md

  • Description: Security overview covering identity authentication, access control, and data encryption features in seekdb.

• File Path: 400.guides/500.manage/300.security/200.identification-and-authentication/100.identification.md

  • Description: Identity identification in seekdb.

• File Path: 400.guides/500.manage/300.security/200.identification-and-authentication/200.password-complexity.md

  • Description: Password complexity requirements in seekdb.

• File Path: 400.guides/500.manage/300.security/200.identification-and-authentication/300.login-failure-handling.md

  • Description: Login failure handling in seekdb.

• File Path: 400.guides/500.manage/300.security/300.access-control/100.access-control-overview.md

  • Description: Access control overview in seekdb.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/50.user-and-permission-overview.md

  • Description: User and permission overview.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/100.permission-classification.md

  • Description: Permission classification in seekdb.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/110.create-user.md

  • Description: How to create a user in seekdb.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/200.direct-authority.md

  • Description: Direct authority management in seekdb.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/300.delegation-of-authority.md

  • Description: Delegation of authority in seekdb.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/340.role-management/100.roles-overview.md

  • Description: Overview of role management in seekdb.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/350.indirect-authority.md

  • Description: Indirect authority management in seekdb.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/400.view-user-permissions.md

  • Description: How to view user permissions.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/500.modify-user-permissions.md

  • Description: How to modify user permissions.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/700.lock-and-unlock-users.md

  • Description: How to lock and unlock users.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/800.delete-a-user.md

  • Description: How to delete a user.

• File Path: 400.guides/500.manage/300.security/300.access-control/300.network-security-access-control.md

  • Description: Network security access control in seekdb.

• File Path: 400.guides/500.manage/300.security/400.data-transfer-encryption/100.data-transfer-encryption-overview.md

  • Description: Data transfer encryption overview in seekdb.

• File Path: 400.guides/500.manage/300.security/400.data-transfer-encryption/200.seekdb-transmission-encryption.md

  • Description: Transmission encryption configuration in seekdb.

OBShell

• File Path: 400.guides/1000.obshell/100.obshell-overview.md

  • Description: Overview of OceanBase Shell (obshell), a local database command-line tool for administrators and developers to manage seekdb clusters and standalone instances.

• File Path: 400.guides/1000.obshell/300.obshell-clients/100.agent-commands.md

  • Description: OBShell agent commands reference.

• File Path: 400.guides/1000.obshell/300.obshell-clients/200.seekdb-commands.md

  • Description: OBShell seekdb commands reference.

• File Path: 400.guides/1000.obshell/300.obshell-clients/300.utilities-commands.md

  • Description: OBShell utilities commands reference.

OBShell Dashboard

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/100.dashboard-overview.md

  • Description: Overview of obshell Dashboard, a web-based visual management interface for seekdb with instance, database, user, alarm, monitoring, parameter, package, and task management.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/200.dashboard-instance.md

  • Description: Instance management in obshell Dashboard.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/300.dashboard-db.md

  • Description: Database management in obshell Dashboard.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/400.dashboard-user.md

  • Description: User management in obshell Dashboard.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/500.dashboard-alarm.md

  • Description: Alarm management in obshell Dashboard.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/600.dashboard-monitor.md

  • Description: Performance monitoring in obshell Dashboard.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/700.dashboard-parameter.md

  • Description: Parameter management in obshell Dashboard.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/800.dashboard-package.md

  • Description: Package management in obshell Dashboard.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/900.ob-dashboard-task.md

  • Description: Task management in obshell Dashboard.

• File Path: 400.guides/1000.obshell/900.configure-monitor.md

  • Description: Guide to configuring monitoring for seekdb.

• File Path: 400.guides/1000.obshell/1000.error.md

  • Description: OBShell error reference and troubleshooting.

Performance Test

VectorDBBench Test

• File Path: 400.guides/1100.performance-test/100.vectordbbench-test-on-seekdb/100.ob-vector-search-bench-test.md

  • Description: Guide to testing seekdb performance using VectorDBBench, a benchmark tool for vector databases. Covers prerequisites, installation, configuration, and running tests.

• File Path: 400.guides/1100.performance-test/100.vectordbbench-test-on-seekdb/200.vectobench-benchmark-report-of-seekdb.md

  • Description: VectorDBBench benchmark report for seekdb.

Sysbench Test

• File Path: 400.guides/1100.performance-test/200.sysbench-test-on-seekdb/100.use-sysbench-to-test-the-performance-of-seekdb.md

  • Description: Guide to testing seekdb performance using Sysbench, a multi-threaded benchmarking tool for CPU, memory, disk I/O, and database performance.

• File Path: 400.guides/1100.performance-test/200.sysbench-test-on-seekdb/200.sysbench-benchmark-report-of-seekdb.md

  • Description: Sysbench benchmark report for seekdb.

Release Notes

• File Path: 400.guides/1300.release-notes/10.v1.0.0.md

  • Description: Release notes for seekdb V1.0.0 (released November 14, 2025). Covers version information, product architecture, core advantages, main features, and new capability overview.

---

Reference

This category contains reference documentation for seekdb including MySQL compatibility, SQL syntax, PL, error codes, SDK, and telemetry.

MySQL Compatibility

• File Path: 450.reference/100.mysql-compatibility.md

  • Description: MySQL compatibility reference for seekdb.

SQL Reference

• File Path: 450.reference/200.sql/90.sql-overview.md

  • Description: Overview of SQL in seekdb, including SQL history, standards, and statement categories.

Data Types

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/100.data-type-overview.md

  • Description: Data type overview in seekdb.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/100.numeric-type.md

  • Description: Numeric data types overview.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/200.integer-type.md

  • Description: Integer types in seekdb.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/300.fixed-point-type.md

  • Description: Fixed-point types in seekdb.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/400.floating-point-type.md

  • Description: Floating-point types in seekdb.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/500.bit-value-type.md

  • Description: Bit value types in seekdb.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/300.date-and-time-types/100.date-and-time-types.md

  • Description: Date and time types overview.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/400.string/100.string-type-overview.md

  • Description: String types overview.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/500.large-object/100.large-object-and-text-type-overview.md

  • Description: Large object and text types overview.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/600.enum-type.md

  • Description: ENUM type in seekdb.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/700.set-type.md

  • Description: SET type in seekdb.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/800.json-formatted-data-type/100.json-formatted-data-types-of-syntax.md

  • Description: JSON data type syntax reference.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/900.spatial-data-type/100.spatial-data-type-overview-of-syntax.md

  • Description: Spatial data type syntax reference.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/1000.roaring-bitmap-data-type/100.roaring-bitmap-data-type-overview.md

  • Description: Roaring bitmap data type overview.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/1200.array-data-type/100.array-data-type-overview.md

  • Description: Array data type overview.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/1300.map-data-type/100.map-data-type-overview.md

  • Description: Map data type overview.

Expressions and Operators

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/200.expression/100.expression-overview.md

  • Description: Expression overview in seekdb SQL.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/100.operator-overview.md

  • Description: Operator overview including arithmetic, comparison, logical, bitwise, and other operators.

Character Sets and Literals

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/100.overview-of-character-set-and-collation.md

  • Description: Character set and collation overview.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/100.literal-overview.md

  • Description: Literal values overview including string, numeric, date/time, and boolean literals.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/500.schema-object-name.md

  • Description: Schema object naming conventions.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/600.custom-variables.md

  • Description: Custom variables in seekdb.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/700.annotation.md

  • Description: SQL annotation/comment syntax.

PL Reference

• File Path: 450.reference/300.pl/100.what-is-pl/100.pl-introduction.md

  • Description: Introduction to PL (Procedural Language) in seekdb, covering performance advantages, development ease, portability, and management benefits.

• File Path: 450.reference/300.pl/100.what-is-pl/200.main-functions-of-pl.md

  • Description: Main functions of PL in seekdb.

• File Path: 450.reference/300.pl/100.what-is-pl/300.pl-architecture.md

  • Description: PL architecture in seekdb.

Storage Objects

• File Path: 450.reference/300.pl/200.storage-object/100.pl-storage-objects-overview.md

  • Description: PL storage objects overview.

• File Path: 450.reference/300.pl/200.storage-object/200.variables-in-stored-programs.md

  • Description: Variables in stored programs.

• File Path: 450.reference/300.pl/200.storage-object/300.pl-stored-procedure.md

  • Description: PL stored procedures.

• File Path: 450.reference/300.pl/200.storage-object/350.pl-stored-routines-privileges.md

  • Description: Stored routines privileges.

• File Path: 450.reference/300.pl/200.storage-object/400.pl-storage-function.md

  • Description: PL storage functions.

• File Path: 450.reference/300.pl/200.storage-object/500.pl-trigger.md

  • Description: PL triggers.

• File Path: 450.reference/300.pl/200.storage-object/550.pl-event.md

  • Description: PL events.

• File Path: 450.reference/300.pl/200.storage-object/600.pl-stored-program-usage-restrictions.md

  • Description: Stored program usage restrictions.

Cursor

• File Path: 450.reference/300.pl/300.cursor/100.overview-of-cursors.md

  • Description: Cursor overview in PL.

• File Path: 450.reference/300.pl/300.cursor/200.cursor-execution-process.md

  • Description: Cursor execution process.

• File Path: 450.reference/300.pl/300.cursor/300.cursor-usage-limits.md

  • Description: Cursor usage limits.

Control Statements

• File Path: 450.reference/300.pl/400.control-statement/100.CASE.md

  • Description: CASE statement in PL.

• File Path: 450.reference/300.pl/400.control-statement/200.IF.md

  • Description: IF statement in PL.

• File Path: 450.reference/300.pl/400.control-statement/300.ITERATE.md

  • Description: ITERATE statement in PL.

• File Path: 450.reference/300.pl/400.control-statement/400.LEAVE.md

  • Description: LEAVE statement in PL.

• File Path: 450.reference/300.pl/400.control-statement/500.LOOP.md

  • Description: LOOP statement in PL.

• File Path: 450.reference/300.pl/400.control-statement/600.REPEAT.md

  • Description: REPEAT statement in PL.

• File Path: 450.reference/300.pl/400.control-statement/700.RETURN.md

  • Description: RETURN statement in PL.

• File Path: 450.reference/300.pl/400.control-statement/800.WHILE.md

  • Description: WHILE statement in PL.

PL Manipulation Statements

• File Path: 450.reference/300.pl/500.pl-manipulation-statement-mysql/100.call.md

  • Description: CALL statement for invoking stored procedures.

• File Path: 450.reference/300.pl/500.pl-manipulation-statement-mysql/200.do.md

  • Description: DO statement in PL.

SQL Statements for PL

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/100.alter-function.md

  • Description: ALTER FUNCTION statement.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/200.alter-procedure.md

  • Description: ALTER PROCEDURE statement.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/500.create-function.md

  • Description: CREATE FUNCTION statement.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/600.create-procedure.md

  • Description: CREATE PROCEDURE statement.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/700.create-trigger.md

  • Description: CREATE TRIGGER statement.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/800.drop-function.md

  • Description: DROP FUNCTION statement.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/900.drop-procedure.md

  • Description: DROP PROCEDURE statement.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/1000.drop-trigger.md

  • Description: DROP TRIGGER statement.

PL Database Management Statements

• File Path: 450.reference/300.pl/700.pl-database-management-statements/100.show-create-function.md

  • Description: SHOW CREATE FUNCTION statement.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/200.show-create-procedure.md

  • Description: SHOW CREATE PROCEDURE statement.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/300.show-create-trigger.md

  • Description: SHOW CREATE TRIGGER statement.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/400.show-function-status.md

  • Description: SHOW FUNCTION STATUS statement.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/500.show-procedure-status.md

  • Description: SHOW PROCEDURE STATUS statement.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/600.show-triggers.md

  • Description: SHOW TRIGGERS statement.

Information Schema

• File Path: 450.reference/300.pl/800.information-schema-dictionary-view/100.information-schema-parameters.md

  • Description: INFORMATION_SCHEMA.PARAMETERS view.

• File Path: 450.reference/300.pl/800.information-schema-dictionary-view/200.information-schema-routines.md

  • Description: INFORMATION_SCHEMA.ROUTINES view.

• File Path: 450.reference/300.pl/800.information-schema-dictionary-view/300.information-schema-triggers.md

  • Description: INFORMATION_SCHEMA.TRIGGERS view.

Exception Handling

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/100.exception-handling-statement.md

  • Description: Exception handling statements overview.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/200.declare-condition.md

  • Description: DECLARE CONDITION statement.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/300.declare-handler.md

  • Description: DECLARE HANDLER statement.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/400.get-diagnostics.md

  • Description: GET DIAGNOSTICS statement.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/500.resignal.md

  • Description: RESIGNAL statement.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/600.signal.md

  • Description: SIGNAL statement.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/700.scope-rules-for-handlers.md

  • Description: Scope rules for handlers.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/800.diagnostic-area.md

  • Description: Diagnostic area.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/900.conditional-processing-and-out-or-inout-parameters.md

  • Description: Conditional processing and OUT/INOUT parameters.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/1000.limitations-of-exception-handling.md

  • Description: Limitations of exception handling.

Error Codes

• File Path: 450.reference/600.error-code/100.error-code-overview.md

  • Description: Error message overview including format, variables, and structure.

• File Path: 450.reference/600.error-code/200.0001-3999.md

  • Description: Error codes 0001-3999.

• File Path: 450.reference/600.error-code/300.4000-4499.md

  • Description: Error codes 4000-4499.

• File Path: 450.reference/600.error-code/500.5000-5999.md

  • Description: Error codes 5000-5999.

• File Path: 450.reference/600.error-code/600.6000-6999.md

  • Description: Error codes 6000-6999.

• File Path: 450.reference/600.error-code/800.8000-8999.md

  • Description: Error codes 8000-8999.

• File Path: 450.reference/600.error-code/1000.9500-9999.md

  • Description: Error codes 9500-9999.

• File Path: 450.reference/600.error-code/1050.10000-12000.md

  • Description: Error codes 10000-12000.

• File Path: 450.reference/600.error-code/1100.22998-30926-38104-38105.md

  • Description: Error codes 22998, 30926, 38104, 38105.

Telemetry

• File Path: 450.reference/700.telemetry.md

  • Description: Telemetry reference for seekdb.

SDK Reference

pyseekdb SDK

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/10.pyseekdb-sdk-get-started.md

  • Description: Getting started guide for pyseekdb Python SDK. Covers installation, supported platforms (Linux embedded, macOS server mode, Windows server mode), and connection modes.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/10.pyseekdb-simple-sample.md

  • Description: Simple sample for pyseekdb SDK usage.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/50.pyseekdb-complete-sample.md

  • Description: Complete sample demonstrating all capabilities of pyseekdb SDK.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/100.pyseekdb-hybrid-search-sample.md

  • Description: Hybrid search sample using pyseekdb SDK.

API Reference

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/10.api-overview.md

  • Description: API reference overview for seekdb, including Database, Collection, DML, and DQL APIs.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/50.client.md

  • Description: Client API for connecting to seekdb.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/100.admin-client.md

  • Description: AdminClient API for administrative operations.

Database APIs

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/100.database-overview-of-api.md

  • Description: Database API overview.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/200.create-database-of-api.md

  • Description: create_database() API.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/300.get-database-of-api.md

  • Description: get_database() API.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/400.list-database-of-api.md

  • Description: list_databases() API.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/500.delete-database-of-api.md

  • Description: delete_database() API.

Collection APIs

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/50.collection-overview-of-api.md

  • Description: Collection API overview.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/100.create-collection-of-api.md

  • Description: create_collection() API.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/200.get-collection-of-api.md

  • Description: get_collection() API.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/250.get-or-create-collection-of-api.md

  • Description: get_or_create_collection() API.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/300.list-collection-of-api.md

  • Description: list_collections() API.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/350.count-collection-of-api.md

  • Description: count_collections() API.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/400.delete-collection-of-api.md

  • Description: delete_collection() API.

DML APIs

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/100.dml-overview-of-api.md

  • Description: DML API overview.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/200.add-data-of-api.md

  • Description: add() API for inserting data.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/300.update-data-of-api.md

  • Description: update() API for updating data.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/400.upsert-data-of-api.md

  • Description: upsert() API for insert or update.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/500.delete-data-of-api.md

  • Description: delete() API for deleting data.

DQL APIs

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/100.dql-overview-of-api.md

  • Description: DQL API overview.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/200.query-interfaces-of-api.md

  • Description: query() API for searching data.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/300.get-interfaces-of-api.md

  • Description: get() API for retrieving data by ID.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/400.hybrid-search-of-api.md

  • Description: hybrid_search() API for combined search.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/500.filter-operators-of-api.md

  • Description: Filter operators for query conditions.

Embedding Functions

• File Path: 450.reference/900.sdk/60.embedding-funcations/100.default-embedding-function-of-api.md

  • Description: Default embedding function (DefaultEmbeddingFunction) using all-MiniLM-L6-v2 model with 384 dimensions.

• File Path: 450.reference/900.sdk/60.embedding-funcations/200.create-custim-embedding-functions-of-api.md

  • Description: How to create custom embedding functions.

• File Path: 450.reference/900.sdk/60.embedding-funcations/300.using-custom-embedding-functions-of-api.md

  • Description: How to use custom embedding functions.

---

Tutorials

This category contains step-by-step tutorials for building AI applications with seekdb.

Build AI Application Demos

• File Path: 500.tutorials/100.create-ai-app-demo/100.build-kb-in-seekdb.md

  • Description: Tutorial for building a MineKB (personal local knowledge base) desktop application using seekdb. Covers multi-project management, document processing, intelligent search with HNSW indexes, conversational Q&A with LLMs, and local storage for privacy.

• File Path: 500.tutorials/100.create-ai-app-demo/300.build-multi-model-application-based-on-oceanbase.md

  • Description: Tutorial for building a cultural tourism assistant using seekdb's multi-model integration. Covers combining spatial data with vector search for location-aware recommendations, hybrid GIS and vector queries, and LLM Agent workflow for travel planning.

• File Path: 500.tutorials/100.create-ai-app-demo/400.build-image-search-app-in-seekdb.md

  • Description: Tutorial for building an image search application using seekdb's vector search technology. Covers image vectorization, storing image vectors, and performing similarity search for image-to-image retrieval.

Scenarios

• File Path: 500.tutorials/200.scenarios/15.basic-sql-operations.md

  • Description: Basic SQL operations in seekdb including creating databases, table operations (CREATE, ALTER, DROP), index operations, data manipulation (INSERT, DELETE, UPDATE, SELECT), transaction control (COMMIT, ROLLBACK), and user management.

• File Path: 500.tutorials/200.scenarios/30.experience-vector-search.md

  • Description: Guide to experiencing vector search in seekdb. Covers creating vector columns and indexes, inserting vector data, performing vector search using SQL, and comparison between exact search and approximate search using HNSW indexes.

• File Path: 500.tutorials/200.scenarios/40.experience-full-text-indexing.md

  • Description: Guide to experiencing full-text indexing in seekdb. Covers how full-text indexing works with BM25 algorithm, creating full-text indexes with different tokenizers (Beng, IK, space, ngram), Boolean mode queries, and performance comparison with MySQL.

• File Path: 500.tutorials/200.scenarios/50.experience-hybrid-search.md

  • Description: Guide to hybrid search combining vector-based semantic search and full-text keyword search. Covers pure vector search, pure full-text search, hybrid search using DBMS_HYBRID_SEARCH package, and parameter tuning with boost weights.

• File Path: 500.tutorials/200.scenarios/60.experience-ai-function.md

  • Description: Guide to AI function service in seekdb. Covers AI_EMBED for text-to-vector conversion, AI_COMPLETE and AI_PROMPT for text generation with LLMs, AI_RERANK for result reranking, and building an intelligent Q&A system combining all functions.

• File Path: 500.tutorials/200.scenarios/70.experience-hybrid-vector-index.md

  • Description: Guide to hybrid vector indexes that automatically convert text to vectors and build indexes. Covers creating hybrid vector indexes, inserting text data without manual vectorization, and using semantic_distance function for text-based retrieval.

• File Path: 500.tutorials/200.scenarios/80.experience-vibe-coding-paradigm-with-cursor-agent-oceanbase-mcp.md

  • Description: Guide to the Vibe Coding paradigm using Cursor Agent and OceanBase MCP. Covers setting up Cursor with OceanBase MCP Server, configuring database connections, and building RESTful APIs using natural language instructions.

---

Demos

This category contains live demos showcasing seekdb capabilities.

• File Path: 600.demos/10.demo-overview.md

  • Description: Live demos overview including AI Knowledge Base with Vector Search for instant Q&A and Image Search with Vector Search for SQL+AI image retrieval applications.

---

Quick Reference

Common Topics by Use Case

Getting Started with seekdb

• seekdb Overview: 100.get-started/10.overview/10.seekdb-overview.md
• Quick Deploy (Docker): 100.get-started/100.use-seekdb-with-sql/10.deploy-seekdb-testing-environment.md
• Basic SQL Operations: 500.tutorials/200.scenarios/15.basic-sql-operations.md

Vector Search

• Vector Search Intro: 200.develop/100.vector-search/100.vector-search-overview/100.vector-search-intro.md
• Experience Vector Search: 500.tutorials/200.scenarios/30.experience-vector-search.md
• Vector Indexes: 200.develop/100.vector-search/200.vector-index/200.dense-vector-index.md

Full-Text Search

• Experience Full-Text Indexing: 500.tutorials/200.scenarios/40.experience-full-text-indexing.md
• Full-Text Index Guide: 200.develop/500.multi-model/300.char-and-text/300.full-text-index.md

Hybrid Search

• Experience Hybrid Search: 500.tutorials/200.scenarios/50.experience-hybrid-search.md
• Hybrid Search with DBMS_HYBRID_SEARCH: 200.develop/200.hybrid-search/100.vector-index-hybrid-search.md

AI Functions

• Experience AI Functions: 500.tutorials/200.scenarios/60.experience-ai-function.md
• AI Function Reference: 200.develop/300.ai-function/200.ai-function.md

Python SDK

• pyseekdb Getting Started: 450.reference/900.sdk/10.pyseekdb-sdk/10.pyseekdb-sdk-get-started.md
• API Reference: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/10.api-overview.md

MCP Integration

• OceanBase MCP Server: 200.develop/400.mcp-server/400.oceanbase-mcp-server-and-ai-tool-integration-guide.md
• Cursor Integration: 300.integrations/300.developer-tools/100.cursor.md
• Claude Code Integration: 300.integrations/600.mcp/200.claude-code.md
• Vibe Coding with Cursor: 500.tutorials/200.scenarios/80.experience-vibe-coding-paradigm-with-cursor-agent-oceanbase-mcp.md

Framework Integrations

• LangChain: 300.integrations/100.frameworks/100.langchain.md
• LlamaIndex: 300.integrations/100.frameworks/200.llamaindex.md
• Dify: 300.integrations/400.workflows/400.dify.md

Management and Security

• Configuration Management: 400.guides/500.manage/100.configuration-management/100.configuration-management-introduction.md
• Security Overview: 400.guides/500.manage/300.security/100.security-overview.md
• OBShell Dashboard: 400.guides/1000.obshell/350.obshell-dashboard/100.dashboard-overview.md

Performance Testing

• VectorDBBench Test: 400.guides/1100.performance-test/100.vectordbbench-test-on-seekdb/100.ob-vector-search-bench-test.md
• Sysbench Test: 400.guides/1100.performance-test/200.sysbench-test-on-seekdb/100.use-sysbench-to-test-the-performance-of-seekdb.md