dbdoc
dbdoc copied to clipboard
Published
20 hours ago •
chenyahui
chenyahui
A tool for automatically generating database documents
Database to Document
中文介绍
Download
How to use
dbdoc -c config.json
config file
{
"db_info": {
"db_type": "mysql", // required
"ip_port": "127.0.0.1:3306", // required
"username": "root", // required
"password": "", // required
"schema": "cms" // required
},
"includes": [ // optional
],
"excludes": [ // optional
],
"template_path": "", // optional
"out_path": "" // optional
}
| Property | Description | Required |
|---|---|---|
| db_type | database driver name | Required |
| ip_port | database's host and port | Required |
| username | username | Required |
| password | password | Required |
| schema | the schema you want to read | Required |
| includes | the tables you want to generate. Default: all tables | Optional |
| excludes | the tables you dont't want to generate. | Optional |
| template_path | the path of document layout file | Optional |
| out_path | the path you want to save. Default: schema_doc.md |
Optional |
Supported database
| Database | db_type |
|---|---|
| MySQL | mysql |
| SQL Server | mssql |
Template
You can use your own template such as html, json by set the template_path. The tool also offers a default markdown template for you.
{{- .schema}} Document
{{range .tables -}}
# {{.TableName}}
|column|type|description|
| ------| ------ | ------ |
{{- range .Columns}}
|{{.ColumnName}}|{{.ColumnType}}|{{.Description -}}|
{{- end}}
{{end}}
The template uses the golang text/template, you can read the grammar at here
TODO
- Support more database.
- Support Microsoft Office Word/Excel.
- Humanized command line arguments like MySQL.
chenyahui