軟件數(shù)據(jù)庫設計報告文獻

1、軟件數(shù)據(jù)庫設計報告模板軟件數(shù)據(jù)庫設計報告文檔模板1.引言4 TOC o 1-5 h z 編寫目的4項目來源5文檔名定5預期讀者和IM讀建議 5參考資料6.數(shù)據(jù)庫命名規(guī)則7.數(shù)據(jù)庫設計說明7數(shù)據(jù)庫邏輯設計 7數(shù)據(jù)庫物理設計 8數(shù)據(jù)庫分布 8基表設計10視圖設計13索引設計15完整性約束 17授權設計18觸發(fā)器設計19存儲過程設計 20數(shù)據(jù)售制設計 21.詞匯表24.歷史數(shù)據(jù)處理25.引言引言是對這份數(shù)據(jù)庫設計說明書的概覽， 是 為了幫助閱讀者了解這份文檔是如何編寫的，并 且應該如何閱讀、理解和解釋這份文檔。編寫目的說明這份數(shù)據(jù)庫設計說明書是為哪份軟件 產(chǎn)品編寫的，開發(fā)這個軟件產(chǎn)品意義、作用以及

2、最終要達到的意圖。通過這份數(shù)據(jù)庫設計說明書詳盡準確地描述了該軟件產(chǎn)品的數(shù)據(jù)庫結構。如 果這份數(shù)據(jù)庫設計說明書只與整個系統(tǒng)的某一 部分有關系，那么只定義數(shù)據(jù)庫設計說明書中說 明的那個部分或子系統(tǒng)。項目來源具體說明本軟件開發(fā)項目的全部風險承擔 者，以及各自在本階段所需要承擔的主要風險， 首要風險承擔者包括：任務提出者；軟件開發(fā)者；產(chǎn)品使用者。文檔約定描述編寫文檔時所采用的各種排版約定。排 版約定應該包括：命名方法；提示方式；通配符號：等等。預期讀者和閱讀建議列舉本數(shù)據(jù)庫設計說明書所針對的各種不 同的預期讀者，例如，可能包括：開發(fā)人員；項目經(jīng)理；測試人員；文檔編寫人員。并且描述了文檔中，其余部分的內

3、容及其組 織結構，并且針對每一類讀者提出最適合的文檔 閱讀建議。1.5參考資料列舉編寫需求規(guī)格說明書時所用到的參考 文獻及資料，可能包括；本項目的合同書；上級機關有關本項目的批文；本項目已經(jīng)批準的計劃任務書；用戶界面風格指導；開發(fā)本項目時所要用到的標準；系統(tǒng)規(guī)格需求說明；使用實例文檔；屬于本項目的其它已發(fā)表文件；本數(shù)據(jù)庫設計說明書中所引用的文件、資 料；相關軟件產(chǎn)品數(shù)據(jù)庫設計說明書；等等。為了方便讀者查閱，所有參考資料應該按一 定順序排列。如果可能，每份資料都應該給出：標題名稱；作者或者合同簽約者；文件編號或者版本號；發(fā)表日期或者簽約日期；出版單位或者資料來源。.數(shù)據(jù)庫命名規(guī)則完整并且清楚的說

4、明本數(shù)據(jù)庫的命名規(guī)則， 在南京市交通局信息化數(shù)據(jù)庫建設規(guī)范 中已 經(jīng)給出了一個完整的數(shù)據(jù)庫命名規(guī)則，開發(fā)者應 遵守執(zhí)行，如果本數(shù)據(jù)庫的命名規(guī)則與該規(guī)范不 完全一致，應作出解釋。.數(shù)據(jù)庫設計說明數(shù)據(jù)庫邏輯設計數(shù)據(jù)庫設計人員根據(jù)軟件需求分析報告， 創(chuàng)建與數(shù)據(jù)庫相關的實體關系圖（E-R圖）。如采 用面對對象的分析和設計方法，則此處的實體相 當于類。在此處，應給出邏輯設計的完整的 E-R圖。數(shù)據(jù)庫物理設計在此處應給出完整的數(shù)據(jù)庫物理結構 E-R 圖。開發(fā)者應根據(jù)邏輯設計的結果， 進行數(shù)據(jù)庫 的物理設計，并對表結構進行規(guī)范化處理（第一 范式，第二范式，第三范式）。數(shù)據(jù)庫分布數(shù)據(jù)庫分布采用一張表格進行描述

5、，其格式 如下：數(shù) 據(jù)庫編 號數(shù) 據(jù)庫 管理 系統(tǒng)名 稱數(shù) 據(jù)庫 管理 系統(tǒng)版 本號數(shù) 據(jù)庫英 文名 稱數(shù) 據(jù)庫中 文名 稱數(shù) 據(jù)庫安裝物 理位 置其中:數(shù)據(jù)庫編號給出本系統(tǒng)中指定數(shù)據(jù)庫的順序編號。若本系統(tǒng)中只有一個數(shù)據(jù)庫，則本項 內容不需要描述，本表內容也只有一行。說明：在一個系統(tǒng)中可能安裝若干 個相同的或者不同的數(shù)據(jù)庫管理系統(tǒng)，一個數(shù)據(jù)庫管理系統(tǒng)也可能安裝一 個或者多個數(shù)據(jù)庫。數(shù)據(jù)庫管理系統(tǒng)名稱給出本系統(tǒng)中指定數(shù)據(jù)庫管理系統(tǒng)的商品名稱。若本系統(tǒng)中只有一種數(shù)據(jù)庫管理系 統(tǒng)，則本項內容不需要描述。數(shù)據(jù)庫管理系統(tǒng)版本號給出本系統(tǒng)中指定數(shù)據(jù)庫管理系統(tǒng)的版本號。若本系統(tǒng)中只有一個版本的數(shù)據(jù)庫 管理系

6、統(tǒng)，則本項內容不需要描述。數(shù)據(jù)庫英文名稱給出本數(shù)據(jù)庫的英文名稱，該名稱是 在應用軟件中實際使用的名稱，必須 符合南京市交通局信息化數(shù)據(jù)庫建 設規(guī)范中相關命名規(guī)范。數(shù)據(jù)庫中文名稱給出本數(shù)據(jù)庫的中文名稱，該名稱是 本數(shù)據(jù)庫英文名稱的說明。數(shù)據(jù)庫安裝物理位置給出本數(shù)據(jù)庫安裝的實際位置，必須 描述清楚該位置是在那個物理設備的哪個邏輯存儲設備上，以及存儲文件的 名稱。3.4基表設計每個基表采用一張表格進行描述，其格式如 下：數(shù)據(jù)庫編號：基表編號：基表英文名稱：基表中文名稱：字段編 號英文字 段名中文字 段名字 段類型備 注說明：其中數(shù)據(jù)庫編號含義同上?；砭幪柦o出本基表的順序編號?；碛⑽拿Q給出本基表

7、的英文名稱，該名稱是在 應用軟件中實際使用的名稱，必須符合命名規(guī)范?；碇形拿Q給出本基表的中文名稱，該名稱是本 基表英文名稱的說明。字段編號該基表中，各個字段的順序編號。英文字段名該基表中，各個字段的英文名稱，該 名稱必須符合南京市交通局信息化 數(shù)據(jù)庫建設規(guī)范中相關命名規(guī)范。中文字段名該基表中，各個字段的中文名稱，該名稱是英文字段名的說明字段類型該基表中，各個字段的類型；如果需 要，在說明類型時，還需要說明字段長度。備注該基表中，各個字段有關的限制性說明，需要描述的內容可能包括：值域；缺省值；空字段限制；顯示格式與小數(shù)位數(shù)；有效性規(guī)則與約束；標題；等等說明說明一些有關本表的、必須描述清楚的問

8、題，需要描述的內容可能包括：主關鍵字；索引、排序方式和類型；觸發(fā)器；數(shù)據(jù)復制；等等3.5視圖設計每個視圖采用一張表格進行描述，其格式如 下：即庫編號：視圖編號：視圖英文名稱：視圖中文名稱：相關基表和視圖：字段 編號英文 字段 名中文 字段 名字段 類型字段源備 注說明：其中：數(shù)據(jù)庫編號含義同上。視圖編號給出本視圖的順序編號。視圖英文名稱給出本視圖的英文名稱，該名稱是在 應用軟件中實際使用的名稱，必須符合命名規(guī)范。視圖中文名稱給出本視圖的中文名稱，該名稱是本 一視圖英文名稱的說明。相關基表和視圖列出建立該視圖時，所用到的基表和 視圖。字段編號該視圖中，各個字段的順序編號。英文字段名該視圖中，各個

9、字段的英文名稱，該 名稱必須符合南京市交通局信息化 數(shù)據(jù)庫建設規(guī)范中相關命名規(guī)范。中文字段名該視圖中，各個字段的中文名稱，該 名稱是英文字段名的說明。字段類型該視圖中，各個字段的類型；如果需 要，在說明類型時，還需要說明字段長度 字段源該視圖中，各個字段的來源，即該字 段原來是那個表或者那個視圖中的那個段；在某些情況下，字段可能來自一 個特定的表達式。備注該視圖中，各個字段有關的限制性說明，包括：值域；缺省值；空字段限制；顯示格式與小數(shù)位數(shù)；有效性規(guī)則與約束；標題；等等。說明說明一些有關本視圖的、必須描述清 楚的問題，需要描述的內容可能包括： 索引；權限；等等3.6索引設計每個數(shù)據(jù)庫的所有采用

10、一張表格進行描述,其格式如下:數(shù)據(jù)庫編號：索基索字備引編號表名稱引名稱段集名 稱注其中：數(shù)據(jù)庫編號含義同上索引編號給出本項索引的順序編號?；砻Q給出本項索引所在的基表名稱。索引名稱給出本項索引的名稱。字段集名稱給出本項索引所在的字段名稱或者 字段集名稱。備注描述有關本項索引中，其它需要說明 的事項，例如：排序方式、等等。3.7完整性約束每個數(shù)據(jù)庫的完整性約束采用一張表格進 行描述，其格式如下：阿庫編號：索 引編號基 表名稱索 引名稱字 段集名 稱備 注其中：數(shù)據(jù)庫編號含義同上。約束編號給出本項完整性約束的順序編號。完整性約束名給出本項完整性約束的名稱?；砻o出本項完整性約束所在的基表名 稱

11、。字段名給出本項完整性約束所在的字段名 稱。約束表達式給出本項完整性約束的邏輯表達式。備注描述有關本項完整性約束中，其它需 要說明的事項。授權設計每個數(shù)據(jù)庫的授權采用一張表格進行描述， 其格式如下：庫編號：授 權編號用 戶名稱對 象名稱權 限備 注其中：數(shù)據(jù)庫編號含義同上。授權編號給出本項授權的順序編號。用戶名稱給出本項授權的用戶名稱，這里的用 戶不一定是具體用戶，也可以是用戶組。對象名稱給出本項授權的對象名稱，例如：基 表、字段、等等。必須注意到，一個用戶可能存在多項 授權，應該逐項描述。權限被授權用戶在該對象上擁有的訪問 權限，例如：查詢權、修改權、等等。備注描述有關本項授權中，其它需要說

12、明 的事項。觸發(fā)器設計數(shù)據(jù)庫編號含義同上。觸發(fā)器編號給出本觸發(fā)器的順序編號。觸發(fā)器英文名稱給出本觸發(fā)器的英文名稱，必須符合 南京市交通局信息化數(shù)據(jù)庫建設規(guī)范中相關命名規(guī)范。觸發(fā)器中文名稱給出本觸發(fā)器的中文名稱，該名稱是本觸發(fā)器英文名稱的說明。觸發(fā)器條件給出該觸發(fā)器產(chǎn)生觸發(fā)的條件。觸發(fā)器結果給出該觸發(fā)器被觸發(fā)后所執(zhí)行的動 作內容。存儲過程設計每個數(shù)據(jù)庫的授權采用一張表格進行描述, 其格式如下：數(shù)據(jù)庫編號：存儲過程編號：存儲過程英文名稱：存儲過程中文名稱：存儲過程內容：說明:其中：數(shù)據(jù)庫編號含義同上C存儲過程編號 給出本存儲過程的順序編號。存儲過程英文名稱給出本存儲過程的英文名稱，該名稱是在應用軟

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

14、范。數(shù)據(jù)復制中文名稱給出本數(shù)據(jù)復制的中文名稱，該名稱 是本數(shù)據(jù)復制英文名稱的說明。源數(shù)據(jù)庫編號作為復制數(shù)據(jù)源的數(shù)據(jù)庫編號，編號 含義同上。目標數(shù)據(jù)庫編號作為復制目標的數(shù)據(jù)庫編號，編號含 義同上。復制說明給出該復制的詳細描述，如果需要， 應該輔以示意圖說明。執(zhí)行方式給出該復制的執(zhí)行方式，描述時應該 說明：自動執(zhí)行必須說明執(zhí)行周期或者執(zhí)行條件。調用執(zhí)行必須說明被那個模塊調用，以及是手 動調用，還是條件調用。源數(shù)據(jù)庫名稱給出對應源數(shù)據(jù)庫編號的源數(shù)據(jù)庫 名稱。目標數(shù)據(jù)庫名稱給出對應目標數(shù)據(jù)庫編號的目標數(shù) 據(jù)庫名稱?；砻Q分別給出源數(shù)據(jù)庫和目標數(shù)據(jù)庫中， 進行對應復制的源基表名稱和目標基表事例。字段名

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