-
Notifications
You must be signed in to change notification settings - Fork 95
/
mysql_markdown.go
329 lines (295 loc) · 8.74 KB
/
mysql_markdown.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
/*
Author : AlicFeng
Email : a@samego.com
Telegram : https://t.me/AlicFeng
Github : https://github.com/alicfeng
*/
package main
import (
"database/sql"
"flag"
"fmt"
"github.com/schollz/progressbar/v3"
"os"
"regexp"
"strconv"
"strings"
"time"
_ "github.com/go-sql-driver/mysql"
)
const (
LANG_CN = "cn"
LANG_EN = "en"
)
/**
Database Configuration
*/
var (
host = flag.String("h", "127.0.0.1", "host(127.0.0.1)")
username = flag.String("u", "root", "username(root)")
password = flag.String("p", "root", "password(root)")
database = flag.String("d", "mysql", "database(mysql)")
port = flag.Int("P", 3306, "port(3306)")
charset = flag.String("c", "utf8", "charset(utf8)")
output = flag.String("o", "", "output location")
tables = flag.String("t", "", "choose tables")
version = flag.Bool("v", false, "show version and exit")
detail = flag.Bool("V", false, "show version and exit")
language = flag.String("l", LANG_CN, "output language,support:cn,en")
)
/**
Structured Query Language
*/
const (
// 查看数据库所有数据表SQL
SqlTables = "SELECT `table_name`,`table_comment` FROM `information_schema`.`tables` WHERE `table_schema`=?"
// 查看数据表列信息SQL
SqlTableColumn = "SELECT `ORDINAL_POSITION`,`COLUMN_NAME`,`COLUMN_TYPE`,`COLUMN_KEY`,`IS_NULLABLE`,`EXTRA`,`COLUMN_COMMENT`,`COLUMN_DEFAULT` FROM `information_schema`.`columns` WHERE `table_schema`=? AND `table_name`=? ORDER BY `ORDINAL_POSITION` ASC"
)
var headers = map[string]string{
LANG_CN: "| 序号 | 名称 | 描述 | 类型 | 键 | 为空 | 额外 | 默认值 |",
LANG_EN: "| SN | Name | Description | Type | Key | Is Null | Extra | Default value |",
}
/**
struct for table column
*/
type tableColumn struct {
OrdinalPosition uint16 `db:"ORDINAL_POSITION"` // position
ColumnName string `db:"COLUMN_NAME"` // name
ColumnType string `db:"COLUMN_TYPE"` // type
ColumnKey sql.NullString `db:"COLUMN_KEY"` // key
IsNullable string `db:"IS_NULLABLE"` // nullable
Extra sql.NullString `db:"EXTRA"` // extra
ColumnComment sql.NullString `db:"COLUMN_COMMENT"` // comment
ColumnDefault sql.NullString `db:"COLUMN_DEFAULT"` // default value
}
/**
struct for table message
*/
type tableInfo struct {
Name string `db:"table_name"` // name
Comment sql.NullString `db:"table_comment"` // comment
}
/**
connect mysql service
*/
func connect() (*sql.DB, error) {
// generate dataSourceName
dsn := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?charset=%s", *username, *password, *host, *port, *database, *charset)
db, err := sql.Open("mysql", dsn)
if err != nil {
fmt.Printf("mysql sql open failed, detail is [%v]", err)
return db, err
}
return db, err
}
/**
query table info about scheme
*/
func queryTables(db *sql.DB, dbName string) ([]tableInfo, error) {
var tableCollect []tableInfo
var tableArray []string
var commentArray []sql.NullString
rows, err := db.Query(SqlTables, dbName)
if err != nil {
return tableCollect, err
}
for rows.Next() {
var info tableInfo
err = rows.Scan(&info.Name, &info.Comment)
if err != nil {
fmt.Printf("execute query tables action error,had ignored, detail is [%v]\n", err.Error())
continue
}
tableCollect = append(tableCollect, info)
tableArray = append(tableArray, info.Name)
commentArray = append(commentArray, info.Comment)
}
// filter tables when specified tables params
if *tables != "" {
tableCollect = nil
chooseTables := strings.Split(*tables, ",")
indexMap := make(map[int]int)
for _, item := range chooseTables {
subIndexMap := getTargetIndexMap(tableArray, item)
for k, v := range subIndexMap {
if _, ok := indexMap[k]; ok {
continue
}
indexMap[k] = v
}
}
if len(indexMap) != 0 {
for _, v := range indexMap {
var info tableInfo
info.Name = tableArray[v]
info.Comment = commentArray[v]
tableCollect = append(tableCollect, info)
}
}
}
return tableCollect, err
}
/**
query table column message
*/
func queryTableColumn(db *sql.DB, dbName string, tableName string) ([]tableColumn, error) {
// 定义承载列信息的切片
var columns []tableColumn
rows, err := db.Query(SqlTableColumn, dbName, tableName)
if err != nil {
fmt.Printf("execute query table column action error, detail is [%v]\n", err.Error())
return columns, err
}
for rows.Next() {
var column tableColumn
err = rows.Scan(
&column.OrdinalPosition,
&column.ColumnName,
&column.ColumnType,
&column.ColumnKey,
&column.IsNullable,
&column.Extra,
&column.ColumnComment,
&column.ColumnDefault)
if err != nil {
fmt.Printf("query table column scan error, detail is [%v]\n", err.Error())
return columns, err
}
columns = append(columns, column)
}
return columns, err
}
/**
get choose table index by regexp. then you can batch choose table like `time_zone\w`
*/
func getTargetIndexMap(tableNameArr []string, item string) map[int]int {
indexMap := make(map[int]int)
for i := 0; i < len(tableNameArr); i++ {
if match, _ := regexp.MatchString(item, tableNameArr[i]); match {
if _, ok := indexMap[i]; ok {
continue
}
indexMap[i] = i
}
}
return indexMap
}
/**
init func
*/
func init() {
// init flag for command
flag.CommandLine.Usage = func() {
fmt.Println("Usage: mysql_markdown [options...]\n" +
"--help This help text" + "\n" +
"-h host. default 127.0.0.1" + "\n" +
"-u username. default root" + "\n" +
"-p password. default root" + "\n" +
"-d database. default mysql" + "\n" +
"-P port. default 3306" + "\n" +
"-c charset. default utf8" + "\n" +
"-o output. default current location\n" +
"-t tables. default all table and support ',' separator for filter, every item can use regexp\n" +
"-l language. default cn,support: cn,en" +
"")
os.Exit(0)
}
flag.Parse()
if *version {
fmt.Println("mysql_markdown version: 1.0.5")
os.Exit(0)
}
if *detail {
fmt.Println(
"mysql_markdown version: 1.0.5\n" +
"build by golang 2020.07.04\n" +
"author AlicFeng\n" +
"tutorial https://github.com/alicfeng/mysql_markdown\n" +
"价值源于技术,技术源于分享" +
"")
os.Exit(0)
}
if *language != "" {
if _, ok := headers[*language]; !ok {
fmt.Println("language" + *language + " is not support yet")
os.Exit(1)
}
} else {
*language = LANG_CN
}
fmt.Printf("langguage:%s", *language)
}
/**
main func
*/
func main() {
fmt.Printf("\033[32mconnecting to MySQL to export markdown document file.\033[0m \n")
// connect mysql service
db, err := connect()
if err != nil {
fmt.Printf("\033[31mmysql sql open failed ... \033[0m \n")
return
}
defer db.Close()
// query all table name
tables, err := queryTables(db, *database)
if err != nil {
fmt.Printf("\033[31mquery tables of database error (%v) \033[0m \n", err.Error())
return
}
// create and open markdown file
if *output == "" {
// automatically generated if no output file path is specified
*output = *database + "_" + time.Now().Format("20060102_150405") + ".md"
}
mdFile, err := os.OpenFile(*output, os.O_APPEND|os.O_WRONLY|os.O_CREATE, os.ModePerm)
if err != nil {
fmt.Printf("\033[31mcreate and open markdown file error (%v) \033[0m \n", err.Error())
return
}
defer mdFile.Close()
// make markdown format content
var tableContent = "## " + *database + " tables message\n"
bar := progressbar.Default(int64(len(tables)))
var header = headers[*language]
for index, table := range tables {
// make content process log
//fmt.Printf("%d/%d the %s table is making ...\n", index+1, len(tables), table.Name)
// markdown header title
tableContent += "#### " + strconv.Itoa(index+1) + "、 " + table.Name + "\n"
if table.Comment.String != "" {
tableContent += table.Comment.String + "\n"
}
// markdown table header
tableContent += "\n" +
header + "\n" +
"| :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: |\n"
var columnInfo, columnInfoErr = queryTableColumn(db, *database, table.Name)
if columnInfoErr != nil {
continue
}
for _, info := range columnInfo {
tableContent += fmt.Sprintf(
"| %d | `%s` | %s | %s | %s | %s | %s | %s |\n",
info.OrdinalPosition,
info.ColumnName,
strings.ReplaceAll(strings.ReplaceAll(info.ColumnComment.String, "|", "\\|"), "\n", ""),
info.ColumnType,
info.ColumnKey.String,
info.IsNullable,
info.Extra.String,
info.ColumnDefault.String,
)
}
tableContent += "\n\n"
_ = bar.Add(1)
}
_, err = mdFile.WriteString(tableContent)
if nil != err {
fmt.Printf("\033[31mwrite table content failure (%v) \033[0m \n", err.Error())
os.Exit(-1)
}
// close database and file handler for release
fmt.Printf("\033[32mconvert to document finished in %s \033[0m \n", *output)
}