关于 bkend-data
介绍 bkend.ai 数据库操作的参考技能,涵盖表结构、记录、筛选和索引。除 REST 数据 API 外,也整理了用于开发流程的 MCP 工具。
主要功能
- 01七种字段类型与约束
- 02管理数据表及结构版本
- 03记录增删改查、筛选与分页
- 04关联关系与联表查询
- 05单字段及复合索引
适用场景
- 01定义数据表结构与字段
- 02通过 MCP 工具管理记录
- 03筛选、排序和分页数据
- 04通过联表查询获取关联记录
MCP 相关
介绍用于数据表和字段管理、结构与索引版本管理及记录增删改查的 MCP 工具,也说明如何通过 MCP 文档工具获取工具结构和指南。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ ww-w-ai/ bkit-claude-code --skill bkend-data安装后在 Claude Code 中输入/bkend-data确认已加载。
详细介绍
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 | 获取表详情和架构 | table:read |
backend_table_delete | 删除表 | table:delete |
backend_field_manage | 添加/修改/删除字段 | table:update |
backend_index_manage | 管理索引 | table:update |
backend_schema_version_list | 架构版本历史 | table:read |
backend_schema_version_get | 架构版本详情 | table:read |
backend_schema_version_apply | 应用架构版本(回滚) | 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 工具访问以下指南:
| 文档 ID | 内容 |
|---|---|
4_howto_implement_data_crud | CRUD 实现模式 |
7_code_examples_data | CRUD 和文件上传代码示例 |
使用 get_operation_schema 获取任意工具的输入/输出架构。
REST 数据 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/popup-studio-ai/bkend-docs/main/en/mcp/05-data-tools.md
- MCP 表工具:https://raw.githubusercontent.com/popup-studio-ai/bkend-docs/main/en/mcp/04-table-tools.md
- 数据库指南:https://raw.githubusercontent.com/popup-studio-ai/bkend-docs/main/en/database/01-overview.md
- 完整目录:https://raw.githubusercontent.com/popup-studio-ai/bkend-docs/main/SUMMARY.md
评论
支持 Markdown