peanut-database-designer

数据库设计助手。使用 markdown 设计数据库的表结构。

1. 使用代码片段快速生成一段文档。
2. 使用自动补全精准引用本表字段或他表字段。

设计文档示例

# `table_1` - 表注释

表说明。

## 字段

| 字段名      | 注释     | 类型        | 默认值 | 主键 | 可空 |
| ----------- | -------- | ----------- | ------ | ---- | ---- |
| dbid        | 主键     | bigint      |        | 是   | 否   |
| name        | 名称     | varchar(32) |        |      | 否   |
| master_id   | 主表标识 | bigint      |        |      | 否   |
| create_by   | 创建人   | bigint      |        |      | 否   |
| create_time | 创建时间 | datetime    |        |      | 否   |
| update_by   | 更新人   | bigint      |        |      | 是   |
| update_time | 更新时间 | datetime    |        |      | 是   |

## 约束

1. 主键: `pk_table_1`
2. 外键: `fk_table_1_master_id`, `master_id` 对应 `master_table.dbid`
3. 唯一: `uk_table_1_name`, 对应字段为 `name`

## 索引

无

## 说明

1. 计量单位: 无
2. 数据字典: 无

代码片段

1. peanut-table 或 db-table - 设计一张数据库表结构
2. peanut-column 或 db-column - 新增一个空的字段行
3. peanut-column-seq 或 db-column-seq - 新增一个序号字段行
4. peanut-column-parent 或 db-column-parent - 新增一个父级字段行
5. peanut-fk 或 db-fk - 新增一个外键约束
6. peanut-uk 或 db-uk - 新增一个唯一约束

TODO

1. 引用本表字段时自动完成
2. 引用他表字段时自动完成

部署

1. 使用 pnpm 时报缺少依赖，改为 npm 之后正常
2. vsce package 打包
3. vsce publish 发布