數(shù)據(jù)庫設(shè)計(jì)文檔模板

1、. DR-RD-020(V1.1) XxXxx x系統(tǒng)系統(tǒng) 數(shù)據(jù)庫設(shè)計(jì)說明書數(shù)據(jù)庫設(shè)計(jì)說明書 (內(nèi)部資料 請勿外傳) 編編 寫：寫：日日 期：期： 檢檢 查：查：日日 期：期： 審審 核：核：日日 期：期： 批批 準(zhǔn)：準(zhǔn)：日日 期：期： XXXX 公司公司 版權(quán)所有版權(quán)所有 不得復(fù)制不得復(fù)制 XXXXXX 系統(tǒng)系統(tǒng) .1 文檔編號文檔編號版本版本A1密級密級 商密 A 項(xiàng)目名稱項(xiàng)目名稱XxxXxx 系統(tǒng)系統(tǒng) XXXX 公司公司 xxxx 事業(yè)部事業(yè)部 項(xiàng)目來源項(xiàng)目來源 . . 數(shù)據(jù)庫設(shè)計(jì)說明書數(shù)據(jù)庫設(shè)計(jì)說明書 .1 1引言引言.2 1.1編寫目的.2 1.2術(shù)語表.2 1.3參考資料.3 2數(shù)

2、據(jù)庫環(huán)境說明數(shù)據(jù)庫環(huán)境說明.3 3數(shù)據(jù)庫的命名規(guī)則數(shù)據(jù)庫的命名規(guī)則.3 4邏輯設(shè)計(jì)邏輯設(shè)計(jì).3 5物理設(shè)計(jì)物理設(shè)計(jì).4 5.1表匯總.4 5.2表X：XXX 表.4 5.3視圖的設(shè)計(jì).6 5.4存儲過程、函數(shù)及觸發(fā)器的設(shè)計(jì).6 6安全性設(shè)計(jì)安全性設(shè)計(jì).6 6.1防止用戶直接操作數(shù)據(jù)庫的方法.6 6.2用戶帳號密碼的加密方法.7 6.3角色與權(quán)限.7 7優(yōu)化優(yōu)化.7 8數(shù)據(jù)庫管理與維護(hù)說明數(shù)據(jù)庫管理與維護(hù)說明.7 1引言引言 1.1編寫目的編寫目的 例如：本文檔是xx系統(tǒng)概要設(shè)計(jì)文檔的組成部分，編寫數(shù)據(jù)庫設(shè)計(jì)文檔的目的是：明 確數(shù)據(jù)庫的表名、字段名等數(shù)據(jù)信息，用來指導(dǎo)后期的數(shù)據(jù)庫腳本的開發(fā)，本文

3、檔遵循 xx數(shù)據(jù)庫設(shè)計(jì)和開發(fā)規(guī)范 。本文檔的讀者對象是需求人員、系統(tǒng)設(shè)計(jì)人員、開發(fā)人員、 測試人員。 1.2術(shù)語表術(shù)語表 定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語，為讀者在閱讀文檔時(shí)提供必要的參考信息。 序號序號術(shù)語或縮略語術(shù)語或縮略語說明性定義說明性定義 1PM Project Manager,項(xiàng)目經(jīng)理 2 . . 1.3參考資料參考資料 列出有關(guān)資料的名稱、作者、文件編號或版本等。參考資料包括： a需求說明書、架構(gòu)設(shè)計(jì)說明書等； b本項(xiàng)目的其他已發(fā)表的文件； c引用文件、資料、軟件開發(fā)標(biāo)準(zhǔn)等。 資料名稱作者文件編號、版本資料存放地點(diǎn) 2數(shù)據(jù)庫環(huán)境說明數(shù)據(jù)庫環(huán)境說明 提示： （1）說明所采用的數(shù)據(jù)庫系

4、統(tǒng)，設(shè)計(jì)工具，編程工具等 （2）詳細(xì)配置 例如： 數(shù)據(jù)庫實(shí) 例 數(shù)據(jù)庫系 統(tǒng) 數(shù)據(jù)庫部 署環(huán)境 數(shù)據(jù)庫設(shè) 計(jì)工具 數(shù)據(jù)庫存放位 置 說明 實(shí)例名，文 件名 名稱：如 MySql，版本： 4.0 軟硬件、網(wǎng) 絡(luò)環(huán)境 例如： pb,visio,rose 存放位置，絕對 路徑/相對路徑 實(shí)例用途說明 3數(shù)據(jù)庫的命名規(guī)則數(shù)據(jù)庫的命名規(guī)則 提示： （1）說明本數(shù)據(jù)庫的命名規(guī)則，例如：本數(shù)據(jù)庫設(shè)計(jì)完全按照xx數(shù)據(jù)庫設(shè)計(jì)規(guī)范 命名。 （2）如果本數(shù)據(jù)庫的命名規(guī)則與公司的標(biāo)準(zhǔn)不完全一致的話，請作出解釋。 4邏輯設(shè)計(jì)邏輯設(shè)計(jì) 提示：數(shù)據(jù)庫設(shè)計(jì)人員根據(jù)需求文檔，創(chuàng)建與數(shù)據(jù)庫相關(guān)的那部分實(shí)體關(guān)系圖（ERD） 。 如

5、果采用面向?qū)ο蠓椒ǎ∣OAD） ，這里實(shí)體相當(dāng)于類（class） 。 . . 例如： inhr_partner_sp inhr_partner_cp partner_sett_rels coop_rels settle_order_rels partner_sett_order coop_settl_order sp_coop_relscp_coop_rels 伙 伙 伙 伙 伙 伙 伙 伙 伙伙 伙 伙 伙 伙 伙 伙 伙 1 伙 伙 伙 伙 伙 伙 伙 伙 伙 伙 伙 伙 伙 伙 伙 伙 伙 伙 2 5物理設(shè)計(jì)物理設(shè)計(jì) 提示： （1）主要是設(shè)計(jì)表結(jié)構(gòu)。一般地，實(shí)體對應(yīng)于表，實(shí)體的屬性對應(yīng)于

6、表的列，實(shí)體之 間的關(guān)系成為表的約束。邏輯設(shè)計(jì)中的實(shí)體大部分可以轉(zhuǎn)換成物理設(shè)計(jì)中的表，但是它們 并不一定是一一對應(yīng)的。 （2）對表結(jié)構(gòu)進(jìn)行規(guī)范化處理（第三范式） 。 5.1表匯總表匯總 表名功能說明 表 A 表 B 表 C 5.2表X：XXX 表 表的索引: 索引是否建立要根據(jù)具體的業(yè)務(wù)需求來確定。 允許為空：不填的表示為“是” 。 唯一：不填的表示為“是” 。 . . 表的記錄數(shù)和增長量：根據(jù)具體的業(yè)務(wù)需求確定。增長量應(yīng)確定單位時(shí)間如果量大可 以按每天,如果不大可以按每月。 表字段的區(qū)別度：主要是考慮到將來在此字段上建立索引類型選擇時(shí)作為參考,當(dāng)字段 值唯一時(shí)可以不考慮,當(dāng)字段值不唯一時(shí),估

7、算一個(gè)區(qū)別度,近似即 可。例如：如果一個(gè)表的 NAME 字段有共 2000 個(gè)值,其中有 1999 個(gè) 不同值,1999/2000=0.99 越接近 1 區(qū)別度越高,反之區(qū)別度越低。 表的并發(fā)：根據(jù)具體的業(yè)務(wù)需求預(yù)測表的并發(fā)。 表名 數(shù)據(jù)庫用戶 主鍵 其他排序字段 索引字段 序號字段名稱數(shù)據(jù)類型 （精度范圍） 允許為 空 Y/N 唯一 Y/N 區(qū)別度默認(rèn)值約束條件/說明 此表 格的 序號， 與數(shù) 據(jù)庫 的序 號無 關(guān) 字段名稱數(shù)據(jù)類型 Y/NY/N 高/中 /低 主鍵、外鍵，字 段含義，相關(guān)說 明等 Mysql 腳本CREATE TABLE XXX 表名 ( 字段名稱 數(shù)據(jù)類型 NOT NUL

8、L /NULL , 字段名稱 數(shù)據(jù)類型 NOT NULL /NULL , 字段名稱 數(shù)據(jù)類型 NOT NULL /NULL , 字段名稱 數(shù)據(jù)類型 NOT NULL /NULL , CONSTRAINT PK_XXX 表名_XXX 表字段 PRIMARY KEY (字段名稱) ) type = INNODB; ALTER TABLE XXX 表名 ADD CONSTRAINT FK_XXX 表名_YYY 表名_XXX 表字 段 FOREIGN KEY (字段名稱) REFERENCES YYY 表名 (字段名稱) CREATE INDEX 索引名 ON XXX 表名 (字段名稱) 記錄數(shù)此表的

9、記錄數(shù) 增長量此表的增長量 表的并發(fā)此表的并發(fā)程度 補(bǔ)充說明補(bǔ)充說明 . . 5.3視圖的設(shè)計(jì)視圖的設(shè)計(jì) 根據(jù) XXX 產(chǎn)品的概要設(shè)計(jì)文檔來確定。 視圖的命名按照xx 數(shù)據(jù)庫設(shè)計(jì)規(guī)范中關(guān)于視圖的命名規(guī)范命名。 視圖的設(shè)計(jì)應(yīng)注意以下幾點(diǎn): 1 盡量減少列中使用的公式。 2 去掉所有不必要的列。 3 不要使同一個(gè)文檔屬于多個(gè)分類。 4 避免使用表單公式。 5.45.4存儲過程、函數(shù)及觸發(fā)器的設(shè)計(jì)存儲過程、函數(shù)及觸發(fā)器的設(shè)計(jì) 存儲過程及觸發(fā)器的命名按照xx 數(shù)據(jù)庫設(shè)計(jì)規(guī)范中關(guān)于存儲過程及觸發(fā)器的命 名規(guī)范命名。 存儲過程：根據(jù)具體得業(yè)務(wù)邏輯確定輸入?yún)?shù)個(gè)數(shù)，類型,確定對哪幾個(gè)表進(jìn)行何種作。 在定義存

10、儲過程時(shí)，要使用其完成單一、相對集中的任務(wù)，不要定義已由其 他提供功能的過程。例如：不要定義強(qiáng)制數(shù)據(jù)完整性的過程（使用完整性約 束） 。 函數(shù) ：函數(shù)與存儲過程非常相似，它也是存儲在數(shù)據(jù)庫中的對象。但是可以在 SQL 命令中使用函數(shù)。就好像建立自己的 substr 函數(shù)一樣 觸發(fā)器 ：觸發(fā)器是存儲在數(shù)據(jù)庫中的程序，它在某一特定事件發(fā)生時(shí)執(zhí)行。這些程 序可以用 PL/SQL 和 java 語言編寫，也可以用作 c 語言的調(diào)用，數(shù)據(jù)庫允許 用戶定義這些程序，然后在相關(guān)的表，視圖或者數(shù)據(jù)庫動作執(zhí)行 insert，update 或 delete 語句時(shí)執(zhí)行。 6安全性設(shè)計(jì)安全性設(shè)計(jì) 提示：提高軟件系統(tǒng)

11、的安全性應(yīng)當(dāng)從“管理”和“設(shè)計(jì)”兩方面著手。這里僅考慮數(shù) 據(jù)庫的安全性設(shè)計(jì)。 例如：應(yīng)用級的用戶帳號密碼不能與數(shù)據(jù)庫相同，防止用戶直接操作數(shù)據(jù)庫。用戶只 能用帳號登陸到應(yīng)用軟件，通過應(yīng)用軟件訪問數(shù)據(jù)庫，而沒有其它途徑操作數(shù)據(jù)庫。 6.1防止用戶直接操作數(shù)據(jù)庫的方法防止用戶直接操作數(shù)據(jù)庫的方法 提示：用戶只能用帳號登陸到應(yīng)用軟件，通過應(yīng)用軟件訪問數(shù)據(jù)庫，而沒有其他途徑 操作數(shù)據(jù)庫。 . . 6.2用戶帳號密碼的加密方法用戶帳號密碼的加密方法 提示：對用戶帳號的密碼進(jìn)行加密處理，確保在任何地方都不會出現(xiàn)密碼的明文。 例如：用戶帳號采用MD5進(jìn)行數(shù)據(jù)加密后再錄入數(shù)據(jù)庫，以防止任何地方密碼的安 全性要求。 6.3角色與權(quán)限角色與權(quán)限 提示：確定每個(gè)角色對數(shù)據(jù)庫表的操作權(quán)限，如創(chuàng)建、檢索、更新、刪除等。每個(gè)角 色擁有剛好能夠完成任務(wù)的權(quán)限，不多也不少。在應(yīng)用時(shí)再為用戶分配角色，則每個(gè)用戶 的權(quán)限等于他所兼角色的權(quán)限之和。 角色可以訪問的表與列操作權(quán)限 可訪問所有表完全控制權(quán)限 例如：管理員 角色 B 7優(yōu)化優(yōu)化 提示：分析并優(yōu)化數(shù)據(jù)庫的“時(shí)空”效率，盡可能地“提高處理速度”并且“降低 數(shù)據(jù)占用空間” 。 （1）分析“時(shí)