Skip to content

Commit e711b8d

Browse files
committed
feat(docs): update model and mongo
1 parent 706c93f commit e711b8d

3 files changed

Lines changed: 66 additions & 0 deletions

File tree

docs/src/guide/develop/model.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ gen:
5353
model-ignore-columns: ["create_time", "update_time"]
5454
```
5555
56+
```shell
57+
jzero gen
58+
```
59+
5660
生成的 `internal/model/model.go` 如下:
5761

5862
```go
@@ -112,6 +116,11 @@ desc/sql
112116
└── jzeroadmin_log.operate_log.sql
113117
```
114118

119+
120+
```shell
121+
jzero gen
122+
```
123+
115124
生成的 `internal/model/model.go` 如下:
116125

117126
```go
@@ -195,6 +204,11 @@ gen:
195204
- manage_user_role
196205
```
197206
207+
208+
```shell
209+
jzero gen
210+
```
211+
198212
生成的 `internal/model/model.go``基于本地 sql ddl 文件` 生成的代码一致
199213

200214
jzero 支持多数据源, 通过在 model-datasource-table 中指定 schema 即可
@@ -229,6 +243,11 @@ gen:
229243
- jzeroadmin_log.operate_log
230244
```
231245
246+
247+
```shell
248+
jzero gen
249+
```
250+
232251
生成的 `internal/model/model.go``基于本地 sql ddl 文件` 生成的代码一致
233252

234253
### postgres
@@ -258,6 +277,11 @@ gen:
258277
- manage_user_role
259278
```
260279
280+
281+
```shell
282+
jzero gen
283+
```
284+
261285
生成的 `internal/model/model.go` 与 mysql driver 一致
262286

263287
jzero 支持多数据源, 通过在 model-datasource-table 中指定 schema 即可
@@ -292,6 +316,11 @@ gen:
292316
- jzeroadmin_log.operate_log
293317
```
294318
319+
320+
```shell
321+
jzero gen
322+
```
323+
295324
生成的 `internal/model/model.go` 与 mysql driver 一致
296325

297326
## 默认生成如下方法

docs/src/guide/develop/mongo.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: mongo 使用文档
3+
icon: logos:mongodb
4+
star: true
5+
order: 5
6+
category: 开发
7+
tag:
8+
- Guide
9+
---
10+
11+
## 前言
12+
13+
jzero 支持通过指定 mongo type 将代码到 `internal/mongo` 下.
14+
15+
为了在使用上更加方便, jzero 自动生成了 `internal/mongo/model.go` 文件, 用于注册所有生成的 mongo model.
16+
17+
## 特性
18+
19+
* 支持 redis/sync_map 缓存
20+
21+
## 生成代码
22+
23+
```yaml
24+
gen:
25+
# 指定 mongo type
26+
mongo-type: ["user", "role", "menu"]
27+
# 是否需要缓存
28+
mongo-cache: true
29+
# 指定哪些类型需要缓存
30+
mongo-cache-type:
31+
- user
32+
```
33+
34+
```shell
35+
jzero gen
36+
```

docs/src/guide/gen.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ jzero 根据可描述语言生成代码:
99
* desc/proto: proto 可描述语言, 生成 grpc 服务端/客户端代码. [使用文档](develop/proto.md)
1010
* desc/sql: sql 可描述语言, 生成数据库代码. [使用文档](develop/model.md)
1111
* model datasource: 通过远程数据源生成数据库代码. [使用文档](develop/model.md)
12+
* mongo: 通过指定 mongo type 生成 mongo 代码. [使用文档](develop/mongo.md)
1213

1314
## 生成代码
1415

0 commit comments

Comments
 (0)