數(shù)據(jù)庫設(shè)計說明模板

1、數(shù)據(jù)庫設(shè)計說明V4.0XT-DDD-GF標(biāo)記數(shù)量修改單號簽字日期編制XXX會簽數(shù)據(jù)庫設(shè)計說明校對XXX標(biāo)檢XXX共9頁第1頁審核批準(zhǔn)XXX中國船舶工業(yè)系統(tǒng)工程研究院會簽修訂記錄版本號修訂狀態(tài)簡要說明修訂內(nèi)容和范圍修訂日期修訂人批準(zhǔn)日期注：修訂記錄在體系文件發(fā)布后換版時使用，修訂狀態(tài)欄填寫：A增加，MH修改,D刪除1范圍21.1標(biāo)識21.2系統(tǒng)概述21.3文檔概述22引用文檔23數(shù)據(jù)庫級設(shè)計決策24數(shù)據(jù)庫詳細(xì)設(shè)計34.1 （數(shù)據(jù)庫設(shè)計級別的名稱）35用于數(shù)據(jù)庫訪問或操縱的軟件單元的詳細(xì)設(shè)計 45.1 （軟件單元的項目唯一的標(biāo)識符，或者一組軟件單元的標(biāo)志符）46需求可追蹤性7 7注釋1范圍1.1

2、標(biāo)識本條應(yīng)描述本文檔所適用系統(tǒng)和軟件的完整標(biāo)識，適用時，包括其標(biāo)識號、名 稱、縮略名、版本號和發(fā)布號。簡要說明系統(tǒng)的標(biāo)識號、發(fā)布號、名稱、縮略名、版本號。a）軟件標(biāo)識號：H/ZHGLYJCRJ-01b）發(fā)布號：V01c）名稱：d）縮略名：e）版本號：V1.0 ；f）適用系統(tǒng)：1.2 系統(tǒng)概述本條應(yīng)概述本文檔所適用系統(tǒng)和軟件的用途。它還應(yīng)描述系統(tǒng)與軟件的一般特 性；概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史；標(biāo)識項目的需方、用戶、開發(fā)方和保障機(jī) 構(gòu)等：標(biāo)識當(dāng)前和計劃的運(yùn)行現(xiàn)場；列出其他有關(guān)文檔。分別簡要說明系統(tǒng)的用途、軟件用途標(biāo)識需方、用戶、開發(fā)方等。a）需方：b）用戶：c）開發(fā)方：1.3 文檔概述本條應(yīng)概

3、述本文檔的用途和內(nèi)容，并描述與它的使用有關(guān)的保密性方面的要求。2引用文檔本章應(yīng)列出引用文檔的編號、標(biāo)題、編寫單位、修訂版及日期，還應(yīng)標(biāo)識不能 通過正常采購活動得到的文檔的來源。示例：a）文檔名稱1，編號（若有），編寫單位，版本（若有），日期；b）文檔名稱2，編號（若有），編寫單位，版本（若有），日期。3數(shù)據(jù)庫級設(shè)計決策本章應(yīng)視需要分條給出數(shù)據(jù)庫級設(shè)計決策，即數(shù)據(jù)庫的行為設(shè)計決策（忽略其內(nèi) 部實現(xiàn)，從用戶角度出發(fā)描述數(shù)據(jù)庫將怎樣運(yùn)轉(zhuǎn)以滿足需求）以及其他影響數(shù)據(jù)庫進(jìn) 一步設(shè)計的決策。如果所有這些決策在系統(tǒng)需求或 CSCI需求中均是明確的，本章應(yīng) 如實陳述。對應(yīng)于指定為關(guān)鍵性需求（例如對安全性或保密

4、性需求）的設(shè)計決策，應(yīng) 在專門的章條中加以敘述。如果一個設(shè)計決策依賴于系統(tǒng)狀態(tài)或方式，應(yīng)指明這一依賴性。如果設(shè)計決策的部分或全部在定制的或商用的數(shù)據(jù)庫管理系統(tǒng)（DBMS中進(jìn)行了描述，本章可以直接引用。本章應(yīng)給出或引用理解設(shè)計所需的設(shè)計約定。數(shù)據(jù) 庫級設(shè)計決策的例子如下：a）關(guān)于數(shù)據(jù)庫將接收的查詢或其他輸入以及它將產(chǎn)生的輸出（顯示、報表、消息、響應(yīng)等），包括與其他系統(tǒng)、HWC、CSCI及用戶的接口的設(shè)計決策（本 文檔的5.1.d條指出這項說明應(yīng)考慮的主題）。如果這一信息的全部或部分 在接口設(shè)計說明（TDD）中給出，那么可以直接引用。b）有關(guān)響應(yīng)每個輸入或查詢時數(shù)據(jù)庫行為的設(shè)計決策，包括數(shù)據(jù)庫將執(zhí)

5、行件么動作，響應(yīng)時間和其他性能特性，所選擇的方程式/算法/規(guī)則，處理和對不允許的輸入的處理。c）有關(guān)數(shù)據(jù)庫/數(shù)據(jù)文件如何呈現(xiàn)給用戶的設(shè)計決策（本文檔的4.1條標(biāo)識了 這項說明應(yīng)考慮的主題）。d）有關(guān)所使用的數(shù)據(jù)庫管理系統(tǒng)（包括名稱、版本/發(fā)布版）以及為適應(yīng)需求 的變更而引入到數(shù)據(jù)庫內(nèi)部的靈活性類型的設(shè)計決策。e）有關(guān)數(shù)據(jù)庫應(yīng)提供的可用性、安全性、保密性和操作連續(xù)性的等級和類型 的設(shè)計決策。f）有關(guān)數(shù)據(jù)庫的分布（例如客戶/服務(wù)器）、主數(shù)據(jù)庫文件的更新和維護(hù)的設(shè)計決策，包括維護(hù)一致性、建立同步/重建同步和維持同步、強(qiáng)制完整性和業(yè)務(wù)規(guī)則。g）有關(guān)備份與恢復(fù)的設(shè)計決策，包括數(shù)據(jù)和處理的分布策略，備份和

6、恢復(fù)過 程中允許的動作，以及對新技術(shù)或非標(biāo)準(zhǔn)技術(shù)（如視頻和聲音等）的特殊考 慮。h）關(guān)于重新打包、排序、索引、同步以及一致性的設(shè)計決策，包括自動磁盤 管理和自動空間同收、優(yōu)化策略、存儲與空間大小以及數(shù)據(jù)庫的規(guī)模與繼 承數(shù)據(jù)捕獲等方面的考慮。4數(shù)據(jù)庫詳細(xì)設(shè)計注：本文檔用“數(shù)據(jù)元素集合” 一例來代表在一指定的設(shè)計級別（例如概念設(shè)計、 內(nèi)部設(shè)計、邏輯設(shè)計、物理設(shè)計）上具有結(jié)構(gòu)（數(shù)據(jù)元素的編號/次序/分組）的任何實 體、關(guān)系、模式、字段、表、數(shù)組等，用“數(shù)據(jù)元素” 一詞來代表在該級別下不具 有結(jié)構(gòu)的任何關(guān)系、屬性、字段、單元（cell）、數(shù)據(jù)元素等。4.1 （數(shù)據(jù)庫設(shè)計級別的名稱）本條應(yīng)標(biāo)識數(shù)據(jù)庫設(shè)計

7、級別，并用所選擇的設(shè)計方法的術(shù)語描述數(shù)據(jù)庫的數(shù)據(jù) 元素和數(shù)據(jù)元素集合。（若適用）這些信息應(yīng)包括如下內(nèi)容，它們可按任何適合于所 提供信息的順序提供：a）數(shù)據(jù)庫設(shè)計中各個數(shù)據(jù)元素的特征，例如：1）名稱，標(biāo)識符：項目唯一的標(biāo)識符；非技術(shù)（自然語言）名稱；數(shù)據(jù)元素名稱；技術(shù)名稱（如在數(shù)據(jù)庫中字段名）；縮略名或同義名。2）數(shù)據(jù)類型（字母、數(shù)字、整數(shù)等）。3）大小和格式（如：字符串的長度和標(biāo)點(diǎn)符號）。4）計量單位（如：m等）。5）可能值的范圍或枚舉（如：0 99）。6）準(zhǔn)確性（正確程度）和精度（有效數(shù)位數(shù)）。7）優(yōu)先級別、定時、頻率、容量、排序以及其他約束條件（例如數(shù)據(jù)元素是否可以被更新、業(yè)務(wù)規(guī)則是否適用

8、）。8）保密性約束。9）來源（建立/發(fā)送的實體）和接受者（使用，接收的實體）。i）數(shù)據(jù)庫設(shè)計中的數(shù)據(jù)元素組合體（記錄、消息、文件、數(shù)組、顯示、報表等）的特征，例如：1）名稱/標(biāo)識符：項目唯一的標(biāo)識符；非技術(shù)（自然語言）名稱；技術(shù)名稱（如在代碼或數(shù)據(jù)庫中的記錄名或數(shù)據(jù)結(jié)構(gòu)名）；縮略名或同義名。2）數(shù)據(jù)元素組合體中的數(shù)據(jù)元素及其結(jié)構(gòu)（編號、順序和分組）。3）介質(zhì)（例如磁盤）以及在介質(zhì)上數(shù)據(jù)元素，數(shù)據(jù)元素組合體的結(jié)構(gòu)。4）顯示和其他輸出的視聽特征（例如顏色、布局、字體、圖標(biāo)和其他顯示 元素、蜂鳴音和亮度）。5）數(shù)據(jù)元素組合體之間的關(guān)系，如分類/存取特征。6）優(yōu)先級、定時、頻率、容量、序列及其他約束，

9、例如數(shù)據(jù)元素組合體是 否可以被更新、業(yè)務(wù)規(guī)則是否適用。7）保密性約束。8）來源（建立/發(fā)送的實體）和接受體（使用，接收的實體）。5用于數(shù)據(jù)庫訪問或操縱的軟件單元的詳細(xì)設(shè)計5.1 （軟件單元的項目唯一的標(biāo)識符，或者一組軟件單元的標(biāo)志符）本條應(yīng)該通過項目唯一的標(biāo)識符來標(biāo)識軟件單元，并且對該單元進(jìn)行說明。（若適用）這一說明應(yīng)包括下列信息。本條也可以指定一組軟件單元，然后再分條對它們 分別進(jìn)行標(biāo)識和說明。包含其他軟件單元的軟件單元，可以引用那些軟件單元的說 明，而無需在此重復(fù)。a）（若有）單元設(shè)計決策，例如所使用的算法等，如果此前尚未選定。b）該軟件單元設(shè)計中的任何約束、限定或非常規(guī)特征。c）所采用的

10、不同于為該CSCI所指定語言的編程語言及使用它的理由。d）如果該軟件單元包含過程性命令或是由其組成（例如數(shù)據(jù)庫管理系統(tǒng)（DBMS）中用于定義表和報表的菜單選擇，用于數(shù)據(jù)庫訪問和操縱的在線DBMS查詢，對用于代碼自動生成的圖形用戶接口（GUI）構(gòu)造器的輸入，給操作系統(tǒng)的命令或Shell腳本），應(yīng)列出這些過程性命令，并引用解釋它們的用戶 手冊或其他文檔。e）如果該軟件單元包含、接收或輸出數(shù)據(jù)，（若適用）應(yīng)對它的輸入、輸出以 及其他數(shù)據(jù)元素和數(shù)據(jù)元素集合進(jìn)行說明。該軟件單元的局部數(shù)據(jù)應(yīng)該單 獨(dú)描述，不應(yīng)該和輸入或輸出數(shù)據(jù)混在一起。接口特性可以在此提供，也可以引用接口設(shè)計說明（IDD）。如果一指定的接

11、口實體本 DBD毆有覆蓋（例 女口，一個外部系統(tǒng)），但是其接口特性在本（DBDE描述軟件單元時需要提 至嘰則這些特性應(yīng)作為假設(shè)進(jìn)行描述、或以“當(dāng)未提及實體這樣做時，軟件單元將”的形式進(jìn)行描述。本條可引用其他文檔（例如數(shù)據(jù)字典、協(xié)議標(biāo)準(zhǔn)、用戶接口標(biāo)準(zhǔn)）代替本條的信息描述。（若適用）設(shè)計說明 應(yīng)包括如下內(nèi)容，以適合于所提供信息的任何順序給出，并應(yīng)從接口實體 角度指出這些特性之間的區(qū)別（例如對數(shù)據(jù)元素的大小、頻率或其他特性 的不同期望值）：1）接口的項目唯一的標(biāo)識符。2）（若適用）用名稱、編號、修訂以及文檔引用來標(biāo)識接口實體（軟件單元、 配置項、用戶等）。3）接口實體分配給接口的優(yōu)先級。4）要實現(xiàn)的

12、接口類型（例如實時數(shù)據(jù)傳輸、數(shù)據(jù)的存儲和檢索等）。5）接口實體將提供、儲存、發(fā)送、訪問、接收的各個數(shù)據(jù)元素的特征。本文檔中的4.1.a條標(biāo)識出了在本說明中需要包含的內(nèi)容。6）接口實體將提供、存儲、發(fā)送、訪問、接收的數(shù)據(jù)元素組合體（記錄、消息、文件、數(shù)組、顯示、報表等）的特征。本文檔中的4.1.b條，標(biāo) 識了本說明中需要包含的內(nèi)容。7）接口實體將用于該接口的通信方法的特征，例如：項目唯一的標(biāo)識符；通信鏈接/帶寬/頻率/介質(zhì)和它們的特征； 消息格式；流控制（如：序列編號和緩沖區(qū)分配）； 數(shù)據(jù)傳輸率、周期的或非周期的、以及傳送間隔； 路由、尋址、命名約定：傳輸服務(wù)，包括優(yōu)先級與等級； 安全性/保密性

13、考慮，如：加密、用戶鑒別、隔離和審核。8）接口實體將用于該接口的協(xié)議的特征，如： 項目唯一的標(biāo)識符；協(xié)議的優(yōu)先級別/層次； 打包，包括分段與重組、路由及尋址： 合法性檢查、錯誤控制和恢復(fù)過程；同步，包括連接的建立、保持和終止： 狀態(tài)、標(biāo)識及任何其他報告特征。9）其他特征，例如接口實體的物理兼容性（尺寸、公差、負(fù)荷、電壓和接 插件的兼容性等）。f）如果軟件單元包含邏輯，給出其要使用的邏輯，（若適用）應(yīng)包括：1）該軟件單元執(zhí)行啟動時，其內(nèi)部起作用的條件。2）該軟件單元將控制傳遞給其他軟件單元的條件。3）對每個輸入的響應(yīng)以及響應(yīng)時間，包括數(shù)據(jù)轉(zhuǎn)換、重命名以及數(shù)據(jù)傳輸 操作。4）軟件單元運(yùn)行期間的操作順序和動態(tài)控制序列，包括： 順序控制的方法；該方法的邏輯和輸入條件，例如時序變化、優(yōu)先級分配等； 進(jìn)出內(nèi)存的數(shù)據(jù)傳輸：對離散輸入信號的感知，以及該軟件單元內(nèi)中斷操作之間的時序關(guān)系。5）異常和錯誤處理。6運(yùn)用設(shè)計6.1 數(shù)據(jù)字典設(shè)計對數(shù)據(jù)庫設(shè)計中涉及到的各種項目，如數(shù)據(jù)項、記錄、系、文卷、模式、子模 式等一般要建立起數(shù)據(jù)字典，以說明它們的標(biāo)識符、同義名及有關(guān)信息。在本節(jié)中 要說明對此數(shù)據(jù)字典設(shè)計的基本考慮。6.2 安全保密設(shè)計說明在數(shù)據(jù)庫的設(shè)計中，將