用途
bkend-data 是 bkend.ai 数据库相关操作的参考指南,用于说明如何在 bkend.ai 中管理数据表和记录。它覆盖从表结构定义到数据增删改查的完整链路,适合在开发基于 bkend.ai 后端的应用时查阅。
主要能力
列类型
支持 7 种列类型:String(文本,如 name、email)、Number(数值,如 age、price)、Boolean(真假值,如 isActive)、Date(日期时间,如 birthDate)、Array(数组,如 tags: ["a","b"])、Object(嵌套对象,如 address: {city, zip})、Mixed(任意类型,如 metadata)。
字段约束
- required:字段必须有值
- unique:不允许重复值
- default:未提供时的默认值
自动系统字段
- id:String,自动生成的唯一 ID
- createdBy:String,创建者用户 ID
- createdAt:Date,创建时间戳
- updatedAt:Date,最后更新时间戳
注意:bkend 在所有 API 响应中使用 id(而不是 _id)。
MCP 表管理工具
- backend_table_create:创建表,权限 table:create
- backend_table_list:列出表,权限 table:read
- backend_table_get:获取表详情与 schema,权限 table:read
- backend_table_delete:删除表,权限 table:delete
- backend_field_manage:添加/修改/删除字段,权限 table:update
- backend_index_manage:管理索引,权限 table:update
- backend_schema_version_list:schema 版本历史,权限 table:read
- backend_schema_version_get:schema 版本详情,权限 table:read
- backend_schema_version_apply:应用 schema 版本(回滚),权限 table:update
- backend_index_version_list:索引版本历史,权限 table:read
- backend_index_version_get:索引版本详情,权限 table:read
MCP 数据 CRUD 工具
- backend_data_list:列出记录(筛选、排序、分页),关键参数 tableId、page?、limit?、sortBy?、sortDirection?、andFilters?、orFilters?
- backend_data_get:获取单条记录,关键参数 tableId、recordId
- backend_data_create:创建记录,关键参数 tableId、data: { field: value }
- backend_data_update:部分更新记录,关键参数 tableId、recordId、data: { field: value }
- backend_data_delete:删除记录,关键参数 tableId、recordId
所有数据 CRUD 工具都需要 organizationId、projectId、environmentId(来自 get_context)。
筛选运算符
- $eq:等于,{ "status": { "$eq": "active" } }
- $ne:不等于,{ "role": { "$ne": "admin" } }
- $gt / $gte:大于 / 大于等于,{ "age": { "$gt": 18 } }
- $lt / $lte:小于 / 小于等于,{ "price": { "$lt": 100 } }
- $in / $nin:在数组内 / 不在数组内,{ "tag": { "$in": ["a","b"] } }
MCP 指南文档(通过 search_docs)
可使用 search_docs 工具访问以下指南:
- 4_howto_implement_data_crud:CRUD 实现模式
- 7_code_examples_data:CRUD 与文件上传代码示例
使用 get_operation_schema 可获取任意工具的输入/输出 schema。
REST Data API
- GET /v1/data/{table}:列表(筛选、排序、分页、限制)
- POST /v1/data/{table}:创建
- GET /v1/data/{table}/{id}:获取单条
- PATCH /v1/data/{table}/{id}:部分更新
- DELETE /v1/data/{table}/{id}:删除
过滤方式:
- 文本搜索:?search=keyword
- AND 过滤:?filter[field1]=value1&filter[field2]=value2
- 比较运算符:$eq、$ne、$gt、$gte、$lt、$lte、$in、$nin
- 排序:?sort=field:asc(或 desc)
- 分页:?page=1&limit=20(默认 20,最大 100)
关联与连接
- 配置表关系
- 通过连接查询获取关联数据
索引管理
- 创建单字段与复合索引
- 通过 MCP backend_index_manage 管理
- 对查询性能优化至关重要
官方文档(实时参考)
如需最新数据库文档,可使用 WebFetch:
- MCP 数据工具:https://raw.githubusercontent.com/ww-w-ai/bkend-docs/main/en/mcp/05-data-tools.md
- MCP 表工具:https://raw.githubusercontent.com/ww-w-ai/bkend-docs/main/en/mcp/04-table-tools.md
- 数据库指南:https://raw.githubusercontent.com/ww-w-ai/bkend-docs/main/en/database/01-overview.md
- 完整目录:https://raw.githubusercontent.com/ww-w-ai/bkend-docs/main/SUMMARY.md
使用方式
通过 MCP 工具进行表管理与数据 CRUD 操作,或在应用代码中调用 REST Data API。使用数据类工具前需先通过 get_context 获取 organizationId、projectId、environmentId。表结构变更可通过 schema 版本工具回滚。
适用场景
适用于在 bkend.ai 后端上进行数据建模、记录增删改查、关联数据查询、索引优化和 schema 版本管理等开发任务。
限制
资料未提供具体的价格、平台限制、性能指标或使用配额等信息,这些内容暂未提供。