14 Star 178 Fork 34

妙码生花/BuildAdminDoc

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
databaseSpecification.md 6.37 KB
一键复制 编辑 原始数据 按行查看 历史

数据表设计规范

::: tip 当你使用本规范设计数据表时,搭配 可视化CRUD,可以非常舒畅的完成后台功能制作,推荐直接从0开始,因为拖拽设计的组件参数是最正确的。 :::

字段类型

类型 备注 CRUD 搭配点
enum 枚举型 自动生成单选框
set set 型 自动生成复选框
date 日期型 自动生成日期的选择组件
year 年份型 自动生成年份选择组件
time 时间型 自动生成时间选择组件
datetime/timestamp 时间日期 自动生成时间日期的选择组件
decimal/double/float 浮点型 自动生成 Number 输入框,步长根据默认值自动计算
int/bigint/mediumint/smallint/tinyint 整型 自动生成 Number 输入框,步长为 1
longtext/text/mediumtext/smalltext/tinytext/bigtext 文本型 自动生成 textarea 文本框

字段名称

名称 备注 字段类型要求 CRUD 搭配点
weigh 权重 int 后台的排序字段,如果存在该字段将出现排序按钮,可上下拖动进行排序
create_time 创建时间(可视化生成) bigint 记录的添加时间字段,不需要手动维护
update_time 更新时间(可视化生成) bigint 记录的更新时间的字段,不需要手动维护

字段后缀(名称结尾)

后缀 名称示例 字段类型要求 CRUD 搭配点
array namearray 自动生成数组输入组件
list/select/data namelist 自动生成 select,单选
lists/selects/multi name_selects 自动生成 select,多选
_id user_id 自动生成关联表远程 select,单选
_ids user_ids 自动生成关联表远程 select,多选
city city 自动生成城市选择器(需在模块市场中安装省份城市信息)
image/avatar desc_image 自动生成上传图片组件,单图
images/avatars descimages 自动生成上传图片组件,多图
file attachfile 自动生成上传文件组件,单文件
files attachfiles 自动生成上传文件组件,多文件
icon icon 自动生成图标选择器
color color 自动生成颜色选择器(仅可视化CRUD)
number/int/num add_num 自动生成 Number 输入框,步长根据默认值自动计算
time/datetime refreshtime int 自动创建选择时间日期的组件
textarea/multiline/rows rows varchar 自动生成Textarea输入框
status/state/type status tinyint(1)/char(1) 自动生成单选框
switch/toggle log_switch tinyint(1)/int/enum/char(1) 自动生成开关组件,真值1代表开,假值0代表关
content/editor content longtext/text/mediumtext/smalltext/tinytext/bigtext 自动生成富文本编辑器

字段注释

CRUD会将 字段注释表注释 解析为 字典

将字段 status 注释设置为 状态:0=禁用,1=启用,那么 一键CRUD 生成的页面如下所示。

# 另外的两个参考示例
菜单类型:tab=选项卡,link=链接,iframe=Iframe
扩展属性:none=无,add_rules_only=只添加为路由,add_menu_only=只添加为菜单

表注释示例:

  • 会员组表 将被解析为 会员组管理
  • 会员积分变动表 将被解析为 会员积分变动管理

其他注意事项

  1. 不支持 复合主键,请为数据表设置 单字段主键
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
HTML
1
https://gitee.com/wonderful-code/build-admin-doc.git
git@gitee.com:wonderful-code/build-admin-doc.git
wonderful-code
build-admin-doc
BuildAdminDoc
v2

搜索帮助