We always waste time to make database document, especially when we are developing, it's no time to keep document and database staying on the same page. For that reason I made a small tool to automatically generate document base on database & template file, hope it make people happy with making their own style database document in a second.
- Auto generate database document (table list and column info)
- Preview column information as your reference
- Remember the tables you selected for each connection
- Template-based document format (customize your own format & style)
You can simply click reload button to load all tables. When you click any table in this table list, column information will show up on the right side. It provides you a simple way to check out those information. After pressing the "Generate document" button, the document will be automatically generated for those tables you checked in a second. It sounds great, eh?
- Reload all tables from database via current connection
- Check all tables in list
- Uncheck all tables in list
- Remember checked tables for current connection
- Generate document for checked tables and open it
- Setting (choose connection & document template)
In the setting form, you can maintain connections and decide which one you want to use to generate document. As we mentioned above, it's a template-based database document generator, so we can choose our own template here as well.
- Add / Remove / Select connection string
- Export / Add / Remove / Select document template
- Save settings to config file
I provide a default template to show you how to customize your own document. In #TableListTemplate sheet, you can change everything like header text, font, background color and columns but splitting one table's tags into multiple rows. That's the only rule you need to follow.
[Template for table list]
In #TableSchemaTemplate sheet, you can change everything like removing some columns which you don't need as well but remember to keep the simple rule "Do not split one column's tags into multiple rows" for each column information. Otherwise, you can put #table.name, #table.description and #table.type tag to somewhere you want to show up.
[Template for column info.]
After the file is generated, it will be opened automatically and the format just like the template you design.
[table list sheet]
[column list sheet]
You can change template to meet your requirements as below.
[Template for table list]
[Template for column info.]
The document will be the same format as your design.
[table list sheet]
[column list sheet]
Thanks Astah inspired me to create the template-based document idea.