bkend-data

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

bkend.ai Database Guide

bkend.ai 数据库指南

Column Types (7)

列类型（7种）

Type	Description	Example
String	Text	name, email
Number	Numeric	age, price
Boolean	True/false	isActive
Date	Date/time	birthDate
Array	Array	tags: ["a","b"]
Object	Nested object	address: {city, zip}
Mixed	Any type	metadata

类型	描述	示例
String	文本	name, email
Number	数值	age, price
Boolean	真/假	isActive
Date	日期/时间	birthDate
Array	数组	tags: ["a","b"]
Object	嵌套对象	address: {city, zip}
Mixed	任意类型	metadata

Constraints

约束条件

```
required
```
: Field must have a value
```
unique
```
: No duplicate values allowed
```
default
```
: Default value when not provided

```
required
```
：字段必须有值
```
unique
```
：不允许重复值
```
default
```
：未提供时的默认值

Auto System Fields

自动系统字段

Field	Type	Description
id	String	Auto-generated unique ID
createdBy	String	Creator user ID
createdAt	Date	Creation timestamp
updatedAt	Date	Last update timestamp

Important: bkend uses

id

(NOT

_id

) in all API responses.

字段	类型	描述
id	String	自动生成的唯一ID
createdBy	String	创建者用户ID
createdAt	Date	创建时间戳
updatedAt	Date	最后更新时间戳

重要提示：bkend在所有API响应中使用

id

（而非

_id

）。

MCP Table Management Tools

MCP 表管理工具

Tool	Purpose	Scope
`backend_table_create`	Create table	table:create
`backend_table_list`	List tables	table:read
`backend_table_get`	Get table detail + schema	table:read
`backend_table_delete`	Delete table	table:delete
`backend_field_manage`	Add/modify/delete fields	table:update
`backend_index_manage`	Manage indexes	table:update
`backend_schema_version_list`	Schema version history	table:read
`backend_schema_version_get`	Schema version detail	table:read
`backend_schema_version_apply`	Apply schema version (rollback)	table:update
`backend_index_version_list`	Index version history	table:read
`backend_index_version_get`	Index version detail	table:read

工具	用途	权限范围
`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 Data CRUD Tools

MCP 数据CRUD工具

Tool	Purpose	Key Parameters
`backend_data_list`	List records (filter, sort, paginate)	tableId, page?, limit?, sortBy?, sortDirection?, andFilters?, orFilters?
`backend_data_get`	Get single record	tableId, recordId
`backend_data_create`	Create record	tableId, data: { field: value }
`backend_data_update`	Partial update record	tableId, recordId, data: { field: value }
`backend_data_delete`	Delete record	tableId, recordId

All Data CRUD tools require: organizationId, projectId, environmentId (from

get_context

工具	用途	关键参数
`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

）。

Filter Operators

过滤运算符

Operator	Meaning	Example
`$eq`	Equal	`{ "status": { "$eq": "active" } }`
`$ne`	Not equal	`{ "role": { "$ne": "admin" } }`
`$gt` / `$gte`	Greater than / >=	`{ "age": { "$gt": 18 } }`
`$lt` / `$lte`	Less than / <=	`{ "price": { "$lt": 100 } }`
`$in` / `$nin`	In / Not in array	`{ "tag": { "$in": ["a","b"] } }`

运算符	含义	示例
`$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 Guide Docs (via search_docs)

MCP 指南文档（通过search_docs访问）

Use

search_docs

tool to access these guides:

Doc ID	Content
`4_howto_implement_data_crud`	CRUD implementation patterns
`7_code_examples_data`	CRUD + file upload code examples

Use

get_operation_schema

to get any tool's input/output schema.

使用

search_docs

工具访问以下指南：

文档ID	内容
`4_howto_implement_data_crud`	CRUD实现模式
`7_code_examples_data`	CRUD + 文件上传代码示例

使用

get_operation_schema

获取任意工具的输入/输出模式。

REST Data API

REST 数据API

Method	Endpoint	Description
GET	/v1/data/{table}	List (filter, sort, page, limit)
POST	/v1/data/{table}	Create
GET	/v1/data/{table}/{id}	Get single
PATCH	/v1/data/{table}/{id}	Partial update
DELETE	/v1/data/{table}/{id}	Delete

方法	端点	描述
GET	/v1/data/{table}	列出记录（过滤、排序、分页、限制数量）
POST	/v1/data/{table}	创建记录
GET	/v1/data/{table}/{id}	获取单条记录
PATCH	/v1/data/{table}/{id}	部分更新记录
DELETE	/v1/data/{table}/{id}	删除记录

Filtering

过滤功能

Text search:
```
?search=keyword
```

AND filter:

?filter[field1]=value1&filter[field2]=value2

Comparison operators:
```
$eq
```
,
```
$ne
```
,
```
$gt
```
,
```
$gte
```
,
```
$lt
```
,
```
$lte
```
,
```
$in
```
,
```
$nin
```
Sort:
```
?sort=field:asc
```
(or desc)
Pagination:
```
?page=1&limit=20
```
(default 20, max 100)

文本搜索：
```
?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条）

Relations & Joins

关联与连接

Configure table relationships
Join queries for related data retrieval

配置表关系
关联查询以获取相关数据

Index Management

索引管理

Single/compound index creation
Manage via MCP
```
backend_index_manage
```
Essential for query performance optimization

单字段/复合索引创建
通过MCP
```
backend_index_manage
```
进行管理
对查询性能优化至关重要

Official Documentation (Live Reference)

官方文档（实时参考）

For the latest database documentation, use WebFetch:

MCP Data Tools: https://raw.githubusercontent.com/popup-studio-ai/bkend-docs/main/en/mcp/05-data-tools.md
MCP Table Tools: https://raw.githubusercontent.com/popup-studio-ai/bkend-docs/main/en/mcp/04-table-tools.md
Database Guide: https://raw.githubusercontent.com/popup-studio-ai/bkend-docs/main/en/database/01-overview.md
Full TOC: https://raw.githubusercontent.com/popup-studio-ai/bkend-docs/main/SUMMARY.md

如需最新的数据库文档，请使用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