軟件數(shù)據(jù)庫設計報告文檔模板

...wd......wd......wd...軟件數(shù)據(jù)庫設計報告文檔模板1.引言451.1編寫目的451.2工程來源451.3文檔約定451.4預期讀者和閱讀建議451.5參考資料452.數(shù)據(jù)庫命名規(guī)那么463.數(shù)據(jù)庫設計說明463.1數(shù)據(jù)庫邏輯設計463.2數(shù)據(jù)庫物理設計463.3數(shù)據(jù)庫分布473.4基表設計473.5視圖設計483.6索引設計493.7完整性約束503.8授權設計503.9觸發(fā)器設計513.10存儲過程設計513.11數(shù)據(jù)復制設計524.詞匯表535.歷史數(shù)據(jù)處理53引言引言是對這份數(shù)據(jù)庫設計說明書的概覽，是為了幫助閱讀者了解這份文檔是若何編寫的，并且應該若何閱讀、理解和解釋這份文檔。編寫目的說明這份數(shù)據(jù)庫設計說明書是為哪份軟件產品編寫的，開發(fā)這個軟件產品意義、作用以及最終要到達的意圖。通過這份數(shù)據(jù)庫設計說明書詳盡準確地描述了該軟件產品的數(shù)據(jù)庫構造。如果這份數(shù)據(jù)庫設計說明書只與整個系統(tǒng)的某一局部有關系，那么只定義數(shù)據(jù)庫設計說明書中說明的那個局部或子系統(tǒng)。工程來源具體說明本軟件開發(fā)工程的全部不安全因素承擔者，以及各自在本階段所需要承擔的主要不安全因素，首要不安全因素承擔者包括：任務提出者；軟件開發(fā)者；產品使用者。文檔約定描述編寫文檔時所采用的各種排版約定。排版約定應該包括：命名方法；提示方式；通配符號：等等。預期讀者和閱讀建議列舉本數(shù)據(jù)庫設計說明書所針對的各種不同的預期讀者，例如，可能包括：開發(fā)人員；工程經理；測試人員；文檔編寫人員。并且描述了文檔中，其余局部的內容及其組織構造，并且針對每一類讀者提出最適合的文檔閱讀建議。參考資料列舉編寫需求規(guī)格說明書時所用到的參考文獻及資料，可能包括；本工程的合同書；上級機關有關本工程的批文；本工程已經批準的方案任務書；用戶界面風格指導；開發(fā)本工程時所要用到的標準；系統(tǒng)規(guī)格需求說明；使用實例文檔；屬于本工程的其它已發(fā)表文件；本數(shù)據(jù)庫設計說明書中所引用的文件、資料；相關軟件產品數(shù)據(jù)庫設計說明書；等等。為了方便讀者查閱，所有參考資料應該按一定順序排列。如果可能，每份資料都應該給出：標題名稱；作者或者合同簽約者；文件編號或者版本號；發(fā)表日期或者簽約日期；出版單位或者資料來源。數(shù)據(jù)庫命名規(guī)那么完整并且清楚的說明本數(shù)據(jù)庫的命名規(guī)那么，在?南京市交通局信息化數(shù)據(jù)庫建設標準?中已經給出了一個完整的數(shù)據(jù)庫命名規(guī)那么，開發(fā)者應遵守執(zhí)行，如果本數(shù)據(jù)庫的命名規(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ù)庫的物理設計，并對表構造進展標準化處理(第一范式，第二范式，第三范式)。數(shù)據(jù)庫分布數(shù)據(jù)庫分布采用一張表格進展描述，其格式如下：數(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ù)庫管理系統(tǒng)，那么本項內容不需要描述。數(shù)據(jù)庫英文名稱給出本數(shù)據(jù)庫的英文名稱，該名稱是在應用軟件中實際使用的名稱，必須符合?南京市交通局信息化數(shù)據(jù)庫建設標準?中相關命名標準。數(shù)據(jù)庫中文名稱給出本數(shù)據(jù)庫的中文名稱，該名稱是本數(shù)據(jù)庫英文名稱的說明。數(shù)據(jù)庫安裝物理位置給出本數(shù)據(jù)庫安裝的實際位置，必須描述清楚該位置是在那個物理設備的哪一個邏輯存儲設備上，以及存儲文件的名稱?；碓O計每個基表采用一張表格進展描述，其格式如下：數(shù)據(jù)庫編號：基表編號：基表英文名稱：基表中文名稱：字段編號英文字段名中文字段名字段類型備注說明：其中數(shù)據(jù)庫編號含義同上?；砭幪柦o出本基表的順序編號。基表英文名稱給出本基表的英文名稱，該名稱是在應用軟件中實際使用的名稱，必須符合命名標準?；碇形拿Q給出本基表的中文名稱，該名稱是本基表英文名稱的說明。字段編號該基表中，各個字段的順序編號。英文字段名該基表中，各個字段的英文名稱，該名稱必須符合?南京市交通局信息化數(shù)據(jù)庫建設標準?中相關命名標準。中文字段名該基表中，各個字段的中文名稱，該名稱是英文字段名的說明。字段類型該基表中，各個字段的類型；如果需要，在說明類型時，還需要說明字段長度。備注該基表中，各個字段有關的限制性說明，需要描述的內容可能包括：值域；缺省值；空字段限制；顯示格式與小數(shù)位數(shù)；有效性規(guī)那么與約束；標題；等等說明說明一些有關本表的、必須描述清楚的問題，需要描述的內容可能包括：主關鍵字；索引、排序方式和類型；觸發(fā)器；數(shù)據(jù)復制；等等視圖設計每個視圖采用一張表格進展描述，其格式如下：數(shù)據(jù)庫編號：視圖編號：視圖英文名稱：視圖中文名稱：相關基表和視圖：字段編號英文字段名中文字段名字段類型字段源備注說明：其中：數(shù)據(jù)庫編號含義同上。視圖編號給出本視圖的順序編號。視圖英文名稱給出本視圖的英文名稱，該名稱是在應用軟件中實際使用的名稱，必須符合命名標準。視圖中文名稱給出本視圖的中文名稱，該名稱是本視圖英文名稱的說明。相關基表和視圖列出建設該視圖時，所用到的基表和視圖。字段編號該視圖中，各個字段的順序編號。英文字段名該視圖中，各個字段的英文名稱，該名稱必須符合?南京市交通局信息化數(shù)據(jù)庫建設標準?中相關命名標準。中文字段名該視圖中，各個字段的中文名稱，該名稱是英文字段名的說明。字段類型該視圖中，各個字段的類型；如果需要，在說明類型時，還需要說明字段長度。字段源該視圖中，各個字段的來源，即該字段原來是那個表或者那個視圖中的那個字段；在某些情況下，字段可能來自一個特定的表達式。備注該視圖中，各個字段有關的限制性說明，包括：值域；缺省值；空字段限制；顯示格式與小數(shù)位數(shù)；有效性規(guī)那么與約束；標題；等等。說明說明一些有關本視圖的、必須描述清楚的問題，需要描述的內容可能包括：索引；權限；等等索引設計每個數(shù)據(jù)庫的所有采用一張表格進展描述，其格式如下：數(shù)據(jù)庫編號：索引編號基表名稱索引名稱字段集名稱備注其中：數(shù)據(jù)庫編號含義同上。索引編號給出本項索引的順序編號?；砻Q給出本項索引所在的基表名稱。索引名稱給出本項索引的名稱。字段集名稱給出本項索引所在的字段名稱或者字段集名稱。備注描述有關本項索引中，其它需要說明的事項，例如：排序方式、等等。完整性約束每個數(shù)據(jù)庫的完整性約束采用一張表格進展描述，其格式如下：數(shù)據(jù)庫編號：索引編號基表名稱索引名稱字段集名稱備注其中：數(shù)據(jù)庫編號含義同上。約束編號給出本項完整性約束的順序編號。完整性約束名給出本項完整性約束的名稱?；砻o出本項完整性約束所在的基表名稱。字段名給出本項完整性約束所在的字段名稱。約束表達式給出本項完整性約束的邏輯表達式。備注描述有關本項完整性約束中，其它需要說明的事項。授權設計每個數(shù)據(jù)庫的授權采用一張表格進展描述，其格式如下：數(shù)據(jù)庫編號：授權編號用戶名稱對象名稱權限備注其中：數(shù)據(jù)庫編號含義同上。授權編號給出本項授權的順序編號。用戶名稱給出本項授權的用戶名稱，這里的用戶不一定是具體用戶，也可以是用戶組。對象名稱給出本項授權的對象名稱，例如：基表、字段、等等。必須注意到，一個用戶可能存在多項授權，應該逐項描述。權限被授權用戶在該對象上擁有的訪問權限，例如：查詢權、修改權、等等。備注描述有關本項授權中，其它需要說明的事項。觸發(fā)器設計數(shù)據(jù)庫編號含義同上。觸發(fā)器編號給出本觸發(fā)器的順序編號。觸發(fā)器英文名稱給出本觸發(fā)器的英文名稱，必須符合?南京市交通局信息化數(shù)據(jù)庫建設標準?中相關命名標準。觸發(fā)器中文名稱給出本觸發(fā)器的中文名稱，該名稱是本觸發(fā)器英文名稱的說明。觸發(fā)器條件給出該觸發(fā)器產生觸發(fā)的條件。觸發(fā)器結果給出該觸發(fā)器被觸發(fā)后所執(zhí)行的動作內容。存儲過程設計每個數(shù)據(jù)庫的授權采用一張表格進展描述，其格式如下：數(shù)據(jù)庫編號：存儲過程編號：存儲過程英文名稱：存儲過程中文名稱：存儲過程內容：說明：其中：數(shù)據(jù)庫編號含義同上。存儲過程編號給出本存儲過程的順序編號。存儲過程英文名稱給出本存儲過程的英文名稱，該名稱是在應用軟件中實際使用的名稱，必須符合命名標準。存儲過程中文名稱給出本存儲過程的中文名稱，該名稱是本存儲過程英文名稱的說明。存儲過程內容給出該存儲過程算法或者描述詳細內容，如果需要，應該輔以流程圖說明。說明描述本存儲過程需要說明的一些事項。數(shù)據(jù)復制設計每項數(shù)據(jù)復制采用一張表格進展描述，其格式如下：數(shù)據(jù)復制編號：復制英文名稱：復制中文名稱：源數(shù)據(jù)庫編號：目標數(shù)據(jù)庫編號：復制說明：執(zhí)行方式：源數(shù)據(jù)庫名稱目標數(shù)據(jù)庫名稱基表名稱字段名稱基表名稱字段名稱備注：其中：數(shù)據(jù)復制編號給出本數(shù)據(jù)復制的順序編哥數(shù)據(jù)復制英文名稱給出本數(shù)據(jù)復制的英文名稱，該名稱是在應用軟件中實際使用的名稱，必須符合命名標準。數(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ù)庫名稱。基表名稱分別給出源數(shù)據(jù)庫和目標數(shù)據(jù)庫中，進展對應復制的源基表名稱和目標基表名事例。字段名稱分別給出源基表和目標基表中，進展對應復制的源字段名稱和目