最近,我和1位同事合作設計數據庫表。我們在設計好各個表以后,需要將表的基本信息記錄下來,發給同項目組的同事參閱和評審。最開始,我們不是很清楚如何來描寫每張表的信息。通過與大家商量以后,我們認為通過以下格式描寫數據庫表的基本信息比較恰當。本文可供有類似需求的開發人員參考。
要比較完全地描寫1張數據表,需要交代清楚這5個部份:整體說明、版本說明、表結構說明、建表腳本、初始化語句。以下以員工信息表為例加以說明:
1. 整體說明(表寄存數聽說明,哪些模塊使用)
員工信息表tb_employeeinfo,通過此表可定義每一個員工在數據庫中存儲的基本信息。
使用模塊:員工信息存儲及處理模塊。
2. 版本說明(在哪一個基線的哪一個版本上增加,誰增加的)
XXX在V1.01.01版本基礎之上增加。
3. 表結構說明(必須標明那個字段是主鍵)
員工信息表tb_employeeinfo
字段名稱 | 數據類型 | 是不是可空 | 字段描寫 |
employeeno | varchar2(20) | N | 員工工號,在此字段上建立唯1索引 |
employeename | varchar2(50) | N | 員工姓名 |
employeeage | int | N | 員工年齡 |
employeeaddr | varchar2(100) | Y | 員工地址 |
4. 建表腳本(基于OEACLE數據庫實現)
5. 初始化語句
初始時只存儲1個員工的信息,初始語句以下: