數據庫報告說明與模板

1、.數據庫設計報告引言引言是對這份數據庫設計說明書的概覽，是為了幫助閱讀者了解這份文檔是如何編寫的，并且應該如何閱讀、理解和解釋這份文檔。編寫目的說明這份數據庫設計說明書是為哪份軟件產品編寫的，開發(fā)這個軟件產品意義、作用以及最終要達到的意圖。通過這份數據庫設計說明書詳盡準確地描述了該軟件產品的數據庫結構。如果這份數據庫設計說明書只與整個系統(tǒng)的某一部分有關系，那么只定義數據庫設計說明書中說明的那個部分或子系統(tǒng)。項目來源具體說明本軟件開發(fā)項目的全部風險承擔者，以及各自在本階段所需要承擔的主要風險，首要風險承擔者包括： 任務提出者； 軟件開發(fā)者； 產品使用者。文檔約定描述編寫文檔時所采用的各種排版約定

2、。排版約定應該包括： 命名方法； 提示方式； 通配符號： 等等。預期讀者和閱讀建議列舉本數據庫設計說明書所針對的各種不同的預期讀者，例如，可能包括： 開發(fā)人員； 項目經理； 測試人員； 文檔編寫人員。并且描述了文檔中，其余部分的內容及其組織結構，并且針對每一類讀者提出最適合的文檔閱讀建議。參考資料列舉編寫需求規(guī)格說明書時所用到的參考文獻及資料，可能包括； 本項目的合同書； 上級機關有關本項目的批文； 本項目已經批準的計劃任務書； 用戶界面風格指導； 開發(fā)本項目時所要用到的標準； 系統(tǒng)規(guī)格需求說明； 使用實例文檔； 屬于本項目的其它已發(fā)表文件； 本數據庫設計說明書中所引用的文件、資料； 相關軟件

3、產品數據庫設計說明書； 等等。為了方便讀者查閱，所有參考資料應該按一定順序排列。如果可能，每份資料都應該給出： 標題名稱； 作者或者合同簽約者； 文件編號或者版本號； 發(fā)表日期或者簽約日期； 出版單位或者資料來源。數據庫命名規(guī)則完整并且清楚的說明本數據庫的命名規(guī)則，在南京市交通局信息化數據庫建設規(guī)范中已經給出了一個完整的數據庫命名規(guī)則，開發(fā)者應遵守執(zhí)行，如果本數據庫的命名規(guī)則與該規(guī)范不完全一致，應作出解釋。數據庫設計說明數據庫邏輯設計數據庫設計人員根據軟件需求分析報告，創(chuàng)建與數據庫相關的實體關系圖(E-R圖)。如采用面對對象的分析和設計方法，則此處的實體相當于類。在此處，應給出邏輯設計的完整的

4、E-R圖。數據庫物理設計在此處應給出完整的數據庫物理結構E-R圖。開發(fā)者應根據邏輯設計的結果，進行數據庫的物理設計，并對表結構進行規(guī)范化處理(第一范式，第二范式，第三范式)。數據庫分布數據庫分布采用一張表格進行描述，其格式如下：數據庫編號數據庫管理系統(tǒng)名稱數據庫管理系統(tǒng)版本號數據庫英文名稱數據庫中文名稱數據庫安裝物理位置其中： 數據庫編號給出本系統(tǒng)中指定數據庫的順序編號。若本系統(tǒng)中只有一個數據庫，則本項內容不需要描述，本表內容也只有一行。說明： 在一個系統(tǒng)中可能安裝若干個相同的或者不同的數據庫管理系統(tǒng)，一個數據庫管理系統(tǒng)也可能安裝一個或者多個數據庫。 數據庫管理系統(tǒng)名稱給出本系統(tǒng)中指定數據庫管

5、理系統(tǒng)的商品名稱。若本系統(tǒng)中只有一種數據庫管理系統(tǒng)，則本項內容不需要描述。 數據庫管理系統(tǒng)版本號給出本系統(tǒng)中指定數據庫管理系統(tǒng)的版本號。若本系統(tǒng)中只有一個版本的數據庫管理系統(tǒng)，則本項內容不需要描述。 數據庫英文名稱給出本數據庫的英文名稱，該名稱是在應用軟件中實際使用的名稱，必須符合南京市交通局信息化數據庫建設規(guī)范中相關命名規(guī)范。 數據庫中文名稱給出本數據庫的中文名稱，該名稱是本數據庫英文名稱的說明。 數據庫安裝物理位置給出本數據庫安裝的實際位置，必須描述清楚該位置是在那個物理設備的哪一個邏輯存儲設備上，以及存儲文件的名稱。基表設計每個基表采用一張表格進行描述，其格式如下：數據庫編號：基表編號：

6、基表英文名稱：基表中文名稱：字段編號英文字段名中文字段名字段類型備注說明：其中 數據庫編號含義同上。 基表編號給出本基表的順序編號。 基表英文名稱給出本基表的英文名稱，該名稱是在應用軟件中實際使用的名稱，必須符合命名規(guī)范。 基表中文名稱給出本基表的中文名稱，該名稱是本基表英文名稱的說明。 字段編號該基表中，各個字段的順序編號。 英文字段名該基表中，各個字段的英文名稱，該名稱必須符合南京市交通局信息化數據庫建設規(guī)范中相關命名規(guī)范。 中文字段名該基表中，各個字段的中文名稱，該名稱是英文字段名的說明。 字段類型該基表中，各個字段的類型；如果需要，在說明類型時，還需要說明字段長度。 備注該基表中，各個

7、字段有關的限制性說明，需要描述的內容可能包括：n 值域；n 缺省值；n 空字段限制；n 顯示格式與小數位數；n 有效性規(guī)則與約束；n 標題；n 等等 說明說明一些有關本表的、必須描述清楚的問題，需要描述的內容可能包括：n 主關鍵字；n 索引、排序方式和類型；n 觸發(fā)器；n 數據復制；n 等等視圖設計每個視圖采用一張表格進行描述，其格式如下：數據庫編號：視圖編號：視圖英文名稱：視圖中文名稱：相關基表和視圖：字段編號英文字段名中文字段名字段類型字段源備注說明：其中： 數據庫編號含義同上。 視圖編號給出本視圖的順序編號。 視圖英文名稱給出本視圖的英文名稱，該名稱是在應用軟件中實際使用的名稱，必須符合

8、命名規(guī)范。 視圖中文名稱給出本視圖的中文名稱，該名稱是本視圖英文名稱的說明。 相關基表和視圖列出建立該視圖時，所用到的基表和視圖。 字段編號該視圖中，各個字段的順序編號。 英文字段名該視圖中，各個字段的英文名稱，該名稱必須符合南京市交通局信息化數據庫建設規(guī)范中相關命名規(guī)范。 中文字段名該視圖中，各個字段的中文名稱，該名稱是英文字段名的說明。 字段類型該視圖中，各個字段的類型；如果需要，在說明類型時，還需要說明字段長度。 字段源該視圖中，各個字段的來源，即該字段原來是那個表或者那個視圖中的那個字段；在某些情況下，字段可能來自一個特定的表達式。 備注該視圖中，各個字段有關的限制性說明，包括：n 值

9、域；n 缺省值；n 空字段限制；n 顯示格式與小數位數；n 有效性規(guī)則與約束；n 標題；n 等等。 說明說明一些有關本視圖的、必須描述清楚的問題，需要描述的內容可能包括：n 索引；n 權限；n 等等索引設計每個數據庫的所有采用一張表格進行描述，其格式如下：數據庫編號：索引編號基表名稱索引名稱字段集名稱備注其中： 數據庫編號含義同上。 索引編號給出本項索引的順序編號。 基表名稱給出本項索引所在的基表名稱。 索引名稱給出本項索引的名稱。 字段集名稱給出本項索引所在的字段名稱或者字段集名稱。 備注描述有關本項索引中，其它需要說明的事項，例如：排序方式、等等。完整性約束每個數據庫的完整性約束采用一張表

10、格進行描述，其格式如下：數據庫編號：索引編號基表名稱索引名稱字段集名稱備注其中： 數據庫編號含義同上。 約束編號給出本項完整性約束的順序編號。 完整性約束名給出本項完整性約束的名稱。 基表名給出本項完整性約束所在的基表名稱。 字段名給出本項完整性約束所在的字段名稱。 約束表達式給出本項完整性約束的邏輯表達式。 備注描述有關本項完整性約束中，其它需要說明的事項。授權設計每個數據庫的授權采用一張表格進行描述，其格式如下：數據庫編號：授權編號用戶名稱對象名稱權限備注其中： 數據庫編號含義同上。 授權編號給出本項授權的順序編號。 用戶名稱給出本項授權的用戶名稱，這里的用戶不一定是具體用戶，也可以是用戶

11、組。 對象名稱給出本項授權的對象名稱，例如：基表、字段、等等。必須注意到，一個用戶可能存在多項授權，應該逐項描述。 權限被授權用戶在該對象上擁有的訪問權限，例如：查詢權、修改權、等等。 備注描述有關本項授權中，其它需要說明的事項。觸發(fā)器設計 數據庫編號含義同上。 觸發(fā)器編號給出本觸發(fā)器的順序編號。 觸發(fā)器英文名稱給出本觸發(fā)器的英文名稱，必須符合南京市交通局信息化數據庫建設規(guī)范中相關命名規(guī)范。 觸發(fā)器中文名稱給出本觸發(fā)器的中文名稱，該名稱是本觸發(fā)器英文名稱的說明。 觸發(fā)器條件給出該觸發(fā)器產生觸發(fā)的條件。 觸發(fā)器結果給出該觸發(fā)器被觸發(fā)后所執(zhí)行的動作內容。存儲過程設計每個數據庫的授權采用一張表格進行

12、描述，其格式如下：數據庫編號：存儲過程編號：存儲過程英文名稱：存儲過程中文名稱：存儲過程內容：說明：其中： 數據庫編號含義同上。 存儲過程編號給出本存儲過程的順序編號。 存儲過程英文名稱給出本存儲過程的英文名稱，該名稱是在應用軟件中實際使用的名稱，必須符合命名規(guī)范。 存儲過程中文名稱給出本存儲過程的中文名稱，該名稱是本存儲過程英文名稱的說明。 存儲過程內容給出該存儲過程算法或者描述詳細內容，如果需要，應該輔以流程圖說明。 說明描述本存儲過程需要說明的一些事項。數據復制設計每項數據復制采用一張表格進行描述，其格式如下：數據復制編號：復制英文名稱：復制中文名稱：源數據庫編號：目標數據庫編號：復制說

13、明：執(zhí)行方式：源數據庫名稱目標數據庫名稱基表名稱字段名稱基表名稱字段名稱備注：其中： 數據復制編號給出本數據復制的順序編哥 數據復制英文名稱給出本數據復制的英文名稱，該名稱是在應用軟件中實際使用的名稱，必須符合命名規(guī)范。 數據復制中文名稱給出本數據復制的中文名稱，該名稱是本數據復制英文名稱的說明。 源數據庫編號作為復制數據源的數據庫編號，編號含義同上。 目標數據庫編號作為復制目標的數據庫編號，編號含義同上。 復制說明給出該復制的詳細描述，如果需要，應該輔以示意圖說明。 執(zhí)行方式給出該復制的執(zhí)行方式，描述時應該說明： 自動執(zhí)行必須說明執(zhí)行周期或者執(zhí)行條件。 調用執(zhí)行必須說明被那個模塊調用，以及是

14、手動調用，還是條件調用。 源數據庫名稱給出對應源數據庫編號的源數據庫名稱。 目標數據庫名稱給出對應目標數據庫編號的目標數據庫名稱。 基表名稱分別給出源數據庫和目標數據庫中，進行對應復制的源基表名稱和目標基表名事例。 字段名稱分別給出源基表和目標基表中，進行對應復制的源字段名稱和目標字段名稱。 備注描述本復制中需要說明的一些特殊事項。詞匯表列出本文件中用到的專業(yè)術語的定義，以及有關縮寫的定義(如有可能，列出相關的外文原詞)。為了便于非軟件專業(yè)或者非計算機專業(yè)人士(例如：文檔編寫人員等等。)閱讀數據庫設計說明書，要求使用非軟件專業(yè)或者非計算機專業(yè)的術語進行描述。所以這里所指的專業(yè)術語，是指業(yè)務層面上的專業(yè)術語，而不是軟件專業(yè)或者計算機專業(yè)的術語。但是，對于無法回避的軟件專業(yè)或者計算機專業(yè)術語，也應該列入詞匯表，并且加以準確定義。歷史數據處理嚴格說來，歷史數據處理并不屬于數據庫設計范疇。但是對于大多數數據庫來說，如果歷史數據處理不當，少則數月、多則數年，最終將使數據庫無法正常運行。這段時間的長短取決于數據庫設計容量大小，以及數據流強度(即在單位時間內進入數據庫的數據記錄數量)高低。因此應該設計專門的歸檔數據庫，并根據歷史數據需要保存?zhèn)洳榈臅r間長