README-CN.md

sql2struct

SQL2Struct 是一个可以将 SQL 语句转换成 Go struct 的工具。

在线使用

点击 sql2struct 在线版 进行使用

作为 Chrome 插件使用

1. 使用源码安装 sql2struct

git clone https://github.com/idoubi/sql2struct.git
cd sql2struct
pnpm install

2. 构建 Chrome 插件代码

pnpm build:chrome

3. 本地安装 Chrome 插件

Chrome 浏览器打开 chrome://extensions/

点击”加载已解压的扩展程序“，选择 sql2struct 根目录下的 dist/chrome 文件夹

本地部署使用

1. 使用源码安装 sql2struct

git clone https://github.com/idoubi/sql2struct.git
cd sql2struct
pnpm install

2. 预览

pnpm dev

3. 构建

pnpm build

# or

pnpm build:web

如何使用

1. 打开数据库客户端，执行 show create table xxx\G; 导出 SQL 建表数据

2. 粘贴 SQL 建表语句至 sql2struct 左侧的输入框

粘贴完 SQL 建表语句后，右侧输入框自动生成转换后的 Go struct 代码，复制粘贴到 Go 项目中使用即可

3. 转换配置项

默认情况下，转换成的 Go struct 会带有一个 json 标签。你也可以勾选其他标签。目前支持 json、xml、gorm、xorm、mapstruct 等标签。

点击 Options 按钮，进入设置页面

在 Special Identifiers 配置项，你可以自定义需要全部转换成大写的关键词。

在 Fiedl Maps 配置项，你可以自定义 SQL 字段与 Go struct 字段的映射关系。

其他

欢迎在 Github Issues 提交反馈，欢迎 fork 源码，参与共建。

有任何问题你也可以通过邮件联系我： me@idoubi.cc.