DBCHM 是一款簡(jiǎn)單、實(shí)用的數(shù)據(jù)庫(kù)文檔生成工具! 該工具從最初支持chm文檔格式開始，通過(guò)開源，集思廣益，不斷改進(jìn)，又陸續(xù)支持word、excel、pdf、html、xml、markdown等文檔格式的導(dǎo)出。

支持的數(shù)據(jù)庫(kù)

SqlServer

MySQL

Oracle

PostgreSQL

DB2

SQLite

主要功能

文檔的內(nèi)容都包含什么?

1、序號(hào) | 列名 | 數(shù)據(jù)類型 | 長(zhǎng)度 | 小數(shù)位數(shù) | 主鍵 | 自增 | 允許空 | 默認(rèn)值 | 列說(shuō)明

2、視圖 視圖具體內(nèi)容

3、存儲(chǔ)過(guò)程 存儲(chǔ)過(guò)程具體內(nèi)容

注：Oracle在v1.8.0.3-beta版本及以后暫不會(huì)查詢顯示自增數(shù)據(jù)。

支持哪些文檔格式的導(dǎo)出?

chm

word

excel

pdf

html

xml

markdown

更新表列的注釋，有哪些方式?

1、通過(guò) 工具-批注上載，選擇文件導(dǎo)入進(jìn)行更新批注(注釋)：

1.1 pdm 由powerdesigner設(shè)計(jì)數(shù)據(jù)庫(kù)時(shí)產(chǎn)生。

1.2 xml 由visual studio設(shè)置 實(shí)體類庫(kù)的項(xiàng)目屬性，勾選 XML文檔文件 后生成項(xiàng)目時(shí)產(chǎn)生。

1.3 xml 由dbchm的 XML導(dǎo)出 而產(chǎn)生。

2、列批注 在編輯前的選中狀態(tài)下，可以從 選定行開始 粘貼多行文本內(nèi)容 對(duì)多個(gè)列注釋批量賦值。

常見問(wèn)題

1、連接不上，怎么辦?

1.1、連接數(shù)據(jù)庫(kù)界面填寫的連接信息真的正確無(wú)誤?

1.2、數(shù)據(jù)庫(kù)服務(wù)器有防火墻/安全組限制?

1.3、用 Navicat Premium 連接數(shù)據(jù)庫(kù)服務(wù)器試試!

2、連接數(shù)據(jù)庫(kù)時(shí)，點(diǎn)了 連接/測(cè)試 ，半天沒(méi)響應(yīng)?

可能是連接遠(yuǎn)程數(shù)據(jù)庫(kù)網(wǎng)絡(luò)不好的原因，可以把連接超時(shí)設(shè)置的小一些。

3、dbchm可以連接上，但顯示不了數(shù)據(jù)怎么辦?

3.1、導(dǎo)出文檔前，數(shù)據(jù)庫(kù)使用賬號(hào)要給予root級(jí)別的權(quán)限，非root級(jí)別賬號(hào)連接，可能會(huì)出現(xiàn)表數(shù)據(jù)顯示不全或數(shù)據(jù)查詢因權(quán)限不足，會(huì)查不出來(lái)數(shù)據(jù)!

3.2、dbchm有Bug， 提Issue 或 進(jìn)群里 反饋。

4、表列的批注數(shù)據(jù)我想遷移，怎么辦?

1、使用 dbchm 的 XML導(dǎo)出，對(duì)當(dāng)前數(shù)據(jù)庫(kù)的批注數(shù)據(jù) 就會(huì)導(dǎo)出一個(gè)xml文件。

2、點(diǎn)數(shù)據(jù)連接， 切換至 目標(biāo)數(shù)據(jù)庫(kù)連

3、再用批注上載 就可以選擇剛剛的xml文件，如果數(shù)據(jù)庫(kù)表結(jié)構(gòu)相同，批注就會(huì)更新到目標(biāo)數(shù)據(jù)庫(kù)服上。

5、數(shù)據(jù)庫(kù)比較老，如 Sql Server 2000 ，怎么使用dbchm?

5.1、下載安裝 Navicat Premium

5.2、連接上老舊的數(shù)據(jù)庫(kù)服務(wù)器，將數(shù)據(jù)庫(kù)表結(jié)構(gòu)腳本導(dǎo)出。

5.3、找一臺(tái)高版本的數(shù)據(jù)庫(kù)服務(wù)器，新建一個(gè)臨時(shí)數(shù)據(jù)庫(kù)，將導(dǎo)出的腳本導(dǎo)入。

5.4、然后用dbchm連接高版本的數(shù)據(jù)庫(kù)服務(wù)器。

6、chm文件可以正常導(dǎo)出，但是文件名中文亂碼，打開顯示 無(wú)法訪問(wèn)此頁(yè)

這種情況，有一種可能是win系統(tǒng)的區(qū)域設(shè)置，勾選了

Beta 版：使用Unicode UTF-8提供全球語(yǔ)言支持 。取消勾選后，可能不存在該問(wèn)題。

7、Oracle數(shù)據(jù)庫(kù)連上之后，一直未響應(yīng)，像卡死了一樣，怎么辦?

因?yàn)镺racle的 列是否自增 的sql語(yǔ)句，查詢效率比較低，查的比較慢，沒(méi)有卡死!!請(qǐng)耐心等待!!

當(dāng)前版本

v1.9.0.1 beta

更新內(nèi)容

使用模板/視圖存儲(chǔ)過(guò)程
1、各類文檔生成 的代碼重構(gòu)
2、chm/html可以使用模板生成文檔
3、支持?jǐn)?shù)據(jù)庫(kù)的視圖、存儲(chǔ)過(guò)程導(dǎo)出,默認(rèn)格式化顯示,并且關(guān)鍵字高亮
4、軟件其他細(xì)節(jié)完善

注意：

1、DBCHM v1.8.0.0 版本開始，使用 .net framework 4.7（因使用高版本的jint，為了更好的對(duì)SQL語(yǔ)句格式化以及關(guān)鍵字高亮處理）。
2、最新的jint版本nuget安裝，使用nuget源 myget，