218 lines
10 KiB
Markdown
218 lines
10 KiB
Markdown
# Development Guide
|
|
|
|
This category contains development guides and technical documentation for the SeekDB database.
|
|
|
|
## File List
|
|
|
|
### Vector Search
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/100.vector-search-overview/100.vector-search-intro.md`
|
|
- **Description**: Vector search introduction
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/100.vector-search-overview/300.vector-search-workflow.md`
|
|
- **Description**: Vector search workflow
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/150.vector-embedding-technology.md`
|
|
- **Description**: Vector embedding technology
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/160.store-vector-data.md`
|
|
- **Description**: Store vector data
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/200.vector-index/200.dense-vector-index.md`
|
|
- **Description**: Dense vector index
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/200.vector-index/300.hybrid-vector-index.md`
|
|
- **Description**: Hybrid vector index
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/200.vector-index/400.sparse-vector-index/100.in-memory-sparse-vector-index.md`
|
|
- **Description**: In-memory sparse vector index
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/250.vector-function.md`
|
|
- **Description**: Vector function
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/300.vector-similarity-search.md`
|
|
- **Description**: Vector similarity search
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/700.vector-search-benchmark-test.md`
|
|
- **Description**: Vector search benchmark test
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/700.vector-search-reference/100.vector-data-type.md`
|
|
- **Description**: Vector data type reference
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/700.vector-search-reference/800.vector-sdk-refer.md`
|
|
- **Description**: Vector SDK reference
|
|
|
|
- **File Path**: `official-docs/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**: Vector search supported clients and languages overview
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/700.vector-search-reference/900.vector-search-supported-clients-and-languages/200.vector-pyobvector.md`
|
|
- **Description**: Python vector client
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/700.vector-search-reference/900.vector-search-supported-clients-and-languages/300.vector-search-java-sdk.md`
|
|
- **Description**: Java vector search SDK
|
|
|
|
- **File Path**: `official-docs/200.develop/100.vector-search/800.vector-search-faq.md`
|
|
- **Description**: Vector search FAQ
|
|
|
|
### Hybrid Search
|
|
- **File Path**: `official-docs/200.develop/200.hybrid-search/100.vector-index-hybrid-search.md`
|
|
- **Description**: Vector index hybrid search
|
|
|
|
### AI Function
|
|
- **File Path**: `official-docs/200.develop/300.ai-function/100.ai-function-permission.md`
|
|
- **Description**: AI function permissions
|
|
|
|
- **File Path**: `official-docs/200.develop/300.ai-function/200.ai-function.md`
|
|
- **Description**: AI function usage guide
|
|
|
|
### MCP Server
|
|
- **File Path**: `official-docs/200.develop/400.mcp-server/400.oceanbase-mcp-server-and-ai-tool-integration-guide.md`
|
|
- **Description**: OceanBase MCP server and AI tool integration guide
|
|
|
|
### Multi-Model Data
|
|
#### JSON
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/100.json/100.json-formatted-data-types.md`
|
|
- **Description**: JSON formatted data types
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/100.json/200.create-a-json-value.md`
|
|
- **Description**: Create a JSON value
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/100.json/300.querying-and-modifying-json-values.md`
|
|
- **Description**: Querying and modifying JSON values
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/100.json/400.json-formatted-data-type-conversion.md`
|
|
- **Description**: JSON formatted data type conversion
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/100.json/500.json-partial-update.md`
|
|
- **Description**: JSON partial update
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/100.json/600.json-semi-struct.md`
|
|
- **Description**: JSON semi-structured data
|
|
|
|
#### Spatial Data
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/200.spatial/100.spatial-data-type-overview.md`
|
|
- **Description**: Spatial data type overview
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/200.spatial/200.spacial-reference-system.md`
|
|
- **Description**: Spatial reference system
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/200.spatial/300.create-spatial-columns.md`
|
|
- **Description**: Create spatial columns
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/200.spatial/400.create-spatial-indexes.md`
|
|
- **Description**: Create spatial indexes
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/200.spatial/500.spatial-data-format.md`
|
|
- **Description**: Spatial data format
|
|
|
|
#### Character and Text
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/300.char-and-text/100.char-and-varchar.md`
|
|
- **Description**: CHAR and VARCHAR types
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/300.char-and-text/200.text.md`
|
|
- **Description**: TEXT type
|
|
|
|
- **File Path**: `official-docs/200.develop/500.multi-model/300.char-and-text/300.full-text-index.md`
|
|
- **Description**: Full-text index
|
|
|
|
### Python Development
|
|
- **File Path**: `official-docs/200.develop/1000.python/20.using-seekdb-in-python-mode.md`
|
|
- **Description**: Using SeekDB in Python mode
|
|
|
|
### SDK and API
|
|
- **File Path**: `official-docs/200.develop/900.sdk/10.pyseekdb-sdk/10.pyseekdb-sdk-get-started.md`
|
|
- **Description**: pyseekdb SDK quick start
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/10.pyseekdb-sdk/50.sdk-samples/10.pyseekdb-simple-sample.md`
|
|
- **Description**: pyseekdb simple example
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/10.pyseekdb-sdk/50.sdk-samples/100.pyseekdb-hybrid-search-sample.md`
|
|
- **Description**: pyseekdb hybrid search example
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/10.api-overview.md`
|
|
- **Description**: API overview
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/100.admin-client.md`
|
|
- **Description**: Admin client API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/50.client.md`
|
|
- **Description**: Client API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/110.database/100.database-overview-of-api.md`
|
|
- **Description**: Database API overview
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/110.database/200.create-database-of-api.md`
|
|
- **Description**: Create database API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/110.database/300.get-database-of-api.md`
|
|
- **Description**: Get database API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/110.database/400.list-database-of-api.md`
|
|
- **Description**: List database API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/110.database/500.delete-database-of-api.md`
|
|
- **Description**: Delete database API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/200.collection/50.collection-overview-of-api.md`
|
|
- **Description**: Collection API overview
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/200.collection/100.create-collection-of-api.md`
|
|
- **Description**: Create collection API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/200.collection/200.get-collection-of-api.md`
|
|
- **Description**: Get collection API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/200.collection/250.get-or-create-collection-of-api.md`
|
|
- **Description**: Get or create collection API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/200.collection/300.list-collection-of-api.md`
|
|
- **Description**: List collection API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/200.collection/350.count-collection-of-api.md`
|
|
- **Description**: Count collection API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/200.collection/400.delete-collection-of-api.md`
|
|
- **Description**: Delete collection API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/300.dml/100.dml-overview-of-api.md`
|
|
- **Description**: DML API overview
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/300.dml/200.add-data-of-api.md`
|
|
- **Description**: Add data API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/300.dml/300.update-data-of-api.md`
|
|
- **Description**: Update data API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/300.dml/400.upsert-data-of-api.md`
|
|
- **Description**: Upsert data API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/300.dml/500.delete-data-of-api.md`
|
|
- **Description**: Delete data API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/400.dql/100.dql-overview-of-api.md`
|
|
- **Description**: DQL API overview
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/400.dql/200.query-interfaces-of-api.md`
|
|
- **Description**: Query interfaces API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/400.dql/300.get-interfaces-of-api.md`
|
|
- **Description**: Get interfaces API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/400.dql/400.hybrid-search-of-api.md`
|
|
- **Description**: Hybrid search API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/50.apis/400.dql/500.filter-operators-of-api.md`
|
|
- **Description**: Filter operators API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/60.embedding-funcations/100.default-embedding-function-of-api.md`
|
|
- **Description**: Default embedding function API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/60.embedding-funcations/200.create-custim-embedding-functions-of-api.md`
|
|
- **Description**: Create custom embedding functions API
|
|
|
|
- **File Path**: `official-docs/200.develop/900.sdk/60.embedding-funcations/300.using-custom-embedding-functions-of-api.md`
|
|
- **Description**: Using custom embedding functions API
|
|
|
|
## Summary
|
|
This category contains numerous documentation files covering development-related content including vector search, hybrid search, AI functions, multi-model data, SDKs, and APIs.
|
|
|