AgentbaseDocs
文档目录

表、列、行与索引

操作权限:建表 / 建列 / 建索引 / 改结构需要 databases.write;行数据读写另受表权限与行级安全约束(见下文「表设置」)。

建表

入口:项目侧栏 Databases → 点开数据库 → 表列表页右上 Create table。

字段必填说明
Name是表名称
Table comment否表注释(业务别名 / 备注),最长 256 字符;不改变 Table ID 与 name,仅展示用途
Table ID否展开自定义;自动按名称生成建议值(小写、非法字符剔除、空格转下划线、≤36 字符);规则 a-z A-Z 0-9、句点、连字符、下划线,首字符须为字母或数字。留空则服务端自动生成唯一 ID

成功后通知 "{name} has been created" 并跳转到新表页。云端实例建表后会出现 AI 列建议提示,可用 AI 生成一批候选列(可选,不影响手动建列)。

建列

入口:表页 Columns 页签 → Create column;或在电子表格视图列头菜单选择在左 / 右创建列。

字段必填说明
Key是列的 API 标识,正则 ^[A-Za-z0-9][A-Za-z0-9._\-]*$;创建后应用代码依赖它,命名保持稳定
Type是Text(默认)/ Mediumtext / Longtext / Varchar / Integer / Float / Boolean / Datetime / Email / IP / URL / Enum / Relationship / Point / Line / Polygon / String(已弃用,不建议新用)。Relationship 需实例开启关系支持;Point / Line / Polygon 为空间类型,需实例开启空间支持
Comment否列注释(业务说明),最长 256 字符,不改技术 key

选择类型后出现该类型的专属设置,按类型不同包含:Required(必填)、Array(数组)、Default value(默认值)、Size(文本长度上限)、Elements(Enum 枚举值)、Encrypt(加密,仅文本类;加密列无法用于查询过滤)、关系类型的关系表与双向配置等。填写后保存即建列;支持连续创建模式,不关闭弹窗连续添加多列。

失败与边界:

建索引

入口:表页 Indexes 页签 → Create index;或列头菜单从该列快速发起。

字段必填说明
Key是索引标识,默认自动生成 index_N,可改
Type是Key(普通索引)/ Unique(唯一)/ Fulltext(全文)/ Spatial(空间,仅实例开启空间支持时可选)
Fields是参与索引的列(可多列复合)。Relationship 列不能进索引;Spatial 类型仅支持单个空间列
Order(按列)类型相关Asc / Desc;普通类型每列可选,Spatial 不适用

提交后索引异步构建,列表可见状态;支持多选删除索引。建议为高频过滤与排序字段建索引,避免过多索引拖慢写入。

行编辑与电子表格

表页默认电子表格视图(行列表):

操作方式说明
创建行工具栏 Create row / 行创建表单按列约束填写;必填列缺失会校验失败
单元格内编辑点击单元格即时保存;系统列($id、$createdAt、$updatedAt 等)不可编辑
展开行行尾展开按钮大 JSON、关系字段等复杂内容的完整编辑
复制行行菜单 Duplicate复制为新行(新 $id)
删除行行菜单 Delete不可恢复;需确认
行权限行菜单 Manage permissions仅启用行级安全(Row security)的表可按行配置权限
行活动行菜单 View activity该行的变更记录
排序 / 筛选列头菜单 Sort asc / desc;筛选器组合条件可清除筛选
复制行菜单 Copy URL / Copy as JSON便于调试与分享

生成示例数据:空表或工具栏提供 Generate sample data,按列类型生成一批测试行;只追加,不删除现有行。适合演示与联调,生产数据请清理。

CSV 导入:表页工具栏的导入入口按 CSV 建行;导入遵循列约束,失败行会报错。大批量导入建议拆批执行。

CSV 导出:表页 Export 页签:选择导出列、分隔符(逗号 / 分号 / 制表符 / 竖线)、是否含表头行、是否按当前筛选导出;提交后通知导出已开始,完成后下载 CSV 文件。

表设置

入口:表页 Settings 页签。

卡片操作风险
Status启用 / 停用表(enabled)停用后应用无法访问该表(带 Key 的 Server SDK 同样受限),数据保留
Name改显示名不影响 Table ID 与已有引用
Table comment编辑表注释(≤256 字符)仅展示;不影响数据
Permissions配置表权限与 Row security(行级安全)收紧权限可能立即影响现有客户端访问;启用行安全后未授权角色读不到行
Danger删除表不可逆:删除表与其全部行数据;删除前先导出或备份