庫表設(shè)計(jì)與操作規(guī)范V1.0

1、 庫表設(shè)計(jì)與操作規(guī)范1/12庫表設(shè)計(jì)與操作規(guī)范庫表設(shè)計(jì)與操作規(guī)范文檔編號(hào)文檔編號(hào)：庫表設(shè)計(jì)與操作規(guī)范文檔信息文檔信息：公司級(jí)別規(guī)范文件文檔名稱文檔名稱：編程規(guī)范文檔類別文檔類別：工程過程 密密 級(jí)級(jí)：內(nèi)部版本信息版本信息：1.0建立日期建立日期：創(chuàng)創(chuàng) 建建 人人： 審審 核核 者者：批批 準(zhǔn)準(zhǔn) 人人：批準(zhǔn)日期批準(zhǔn)日期：保保 管管 人人：存放位置存放位置： 庫表設(shè)計(jì)與操作規(guī)范2/12文檔修訂記錄版本編號(hào)或者更改記錄編號(hào)*變化狀態(tài)簡(jiǎn)要說明（變更內(nèi)容和變更范圍）日期變更人批準(zhǔn)日期批準(zhǔn)人10A新增2014-1-15彭毅*變化狀態(tài)：A增加，M修改，D刪除文檔審批信息序號(hào)審批人角色審批日期簽字備注 庫表設(shè)

2、計(jì)與操作規(guī)范3/12目錄1簡(jiǎn)介 .41.1目的 .41.2適用范圍 .41.3背景描述 .41.4文檔結(jié)構(gòu) .42命名規(guī)范 .52.1數(shù)據(jù)結(jié)構(gòu)規(guī)范 .52.2數(shù)據(jù)庫操作規(guī)范 .11 庫表設(shè)計(jì)與操作規(guī)范4/121 1 1 簡(jiǎn)介簡(jiǎn)介簡(jiǎn)介1.11.11.1 目的目的目的本文制定的目的是為開發(fā)組所有程序員按統(tǒng)一風(fēng)格、形式提供一個(gè)標(biāo)準(zhǔn)，從而改進(jìn)代碼的可維護(hù)性，提高代碼質(zhì)量。1.21.21.2 適用范圍適用范圍適用范圍本文檔的適用范圍為：數(shù)據(jù)庫設(shè)計(jì)人員、數(shù)據(jù)維護(hù)人員。1.31.31.3 背景描述背景描述背景描述庫表規(guī)范對(duì)于設(shè)計(jì)人員、整個(gè)組織非常的重要：軟件成本的 80%來自于維護(hù)幾乎沒有一個(gè)軟件從始至終是

3、有一個(gè)人維護(hù)的軟件規(guī)范可以改進(jìn)代碼的可讀性，使得程序員能夠很快的、徹底的理解庫表設(shè)計(jì)1.41.41.4 文檔結(jié)構(gòu)文檔結(jié)構(gòu)文檔結(jié)構(gòu)該文擋主要分為兩部分：庫表設(shè)計(jì)、命名規(guī)范和庫表操作規(guī)范。 庫表設(shè)計(jì)與操作規(guī)范5/122 2 2 命名規(guī)范命名規(guī)范命名規(guī)范2.12.12.1 數(shù)據(jù)結(jié)構(gòu)規(guī)范數(shù)據(jù)結(jié)構(gòu)規(guī)范數(shù)據(jù)結(jié)構(gòu)規(guī)范2.1.12.1.12.1.1 術(shù)語術(shù)語術(shù)語術(shù)語 數(shù)據(jù)庫對(duì)象數(shù)據(jù)庫對(duì)象：在數(shù)據(jù)庫軟件開發(fā)中，數(shù)據(jù)庫服務(wù)器端涉及的對(duì)象包括物理結(jié)構(gòu)和邏輯結(jié)構(gòu)的對(duì)象。物理結(jié)構(gòu)對(duì)象物理結(jié)構(gòu)對(duì)象：是指設(shè)備管理元素，包括數(shù)據(jù)文件和事務(wù)日志文件的名稱、大小、目錄規(guī)劃、所在的服務(wù)器計(jì)算機(jī)名稱、鏡像等，應(yīng)該有具體的配置規(guī)劃。一

4、般對(duì)數(shù)據(jù)庫服務(wù)器物理設(shè)備的管理規(guī)程，在整個(gè)項(xiàng)目/產(chǎn)品的概要設(shè)計(jì)階段予以規(guī)劃。 邏輯結(jié)構(gòu)對(duì)象邏輯結(jié)構(gòu)對(duì)象：是指數(shù)據(jù)庫對(duì)象的管理元素，包括數(shù)據(jù)庫名稱、表空間、表、字段/域、視圖、索引、觸發(fā)器、存儲(chǔ)過程、函數(shù)、數(shù)據(jù)類型、數(shù)據(jù)庫安全性相關(guān)的設(shè)計(jì)、數(shù)據(jù)庫配置有關(guān)的設(shè)計(jì)以及數(shù)據(jù)庫中其他特性處理相關(guān)的設(shè)計(jì)等。2.1.22.1.22.1.2 命名總體原則命名總體原則命名總體原則命名總體原則 整個(gè)命名的全長(zhǎng)不得超過 30 個(gè)字母 全部使用字母和下劃線_，不能使用中文和其他字符，有特別情況允許使用末尾數(shù)字編號(hào)。例如：Finace1， Finace2. 命名名稱來自于業(yè)務(wù)，全部采用英文單詞 英文單詞過長(zhǎng)可以采用通用

5、的縮寫，盡量表達(dá)出業(yè)務(wù)的含義 如需要兩個(gè)以上的英文單詞做標(biāo)識(shí)名稱，單詞之間要用下劃線_連接 名稱全是由名詞組成的，名詞由大范圍到小范圍排序取名 庫表設(shè)計(jì)與操作規(guī)范6/12 完成某功能的名稱，如函數(shù)和過程，以動(dòng)賓形式取名2.1.32.1.32.1.3 命名規(guī)范（邏輯對(duì)象）命名規(guī)范（邏輯對(duì)象）命名規(guī)范（邏輯對(duì)象）命名規(guī)范（邏輯對(duì)象）1 數(shù)據(jù)庫結(jié)構(gòu)命名數(shù)據(jù)庫結(jié)構(gòu)命名 a) 數(shù)據(jù)庫命名數(shù)據(jù)庫命名數(shù)據(jù)庫的命名要求使用與數(shù)據(jù)庫意義相關(guān)聯(lián)的英文字母，即。例如：china care 數(shù)據(jù)庫的命名為 ccnet； b) 數(shù)據(jù)庫日志設(shè)計(jì)命名數(shù)據(jù)庫日志設(shè)計(jì)命名數(shù)據(jù)庫日志的命名以_.log 格式命名。其中，為有意義的

6、數(shù)據(jù)庫日志名稱。例如： ccnet_redolog.logc) 表空間、數(shù)據(jù)文件命名表空間、數(shù)據(jù)文件命名(主要針對(duì)主要針對(duì) Oracle)表空間名不超過 32 位,為方便維護(hù)應(yīng)盡量與當(dāng)前的應(yīng)用同名，如果小涉及到多用戶訪問的同一用戶數(shù)據(jù)可以用綜合名，或 COMMON、或有一定共同約束的命名。d)用戶命名用戶命名用戶的命名應(yīng)與表空間對(duì)應(yīng)，每個(gè)用戶下的數(shù)據(jù)必須放到與用戶相同的表空間之下。同樣用戶名不超過 32 位。2 數(shù)據(jù)庫對(duì)象命名數(shù)據(jù)庫對(duì)象命名 a) 表表表的命名格式為： 系統(tǒng)標(biāo)識(shí)_。 庫表設(shè)計(jì)與操作規(guī)范7/12其中， 為必埴項(xiàng)，依據(jù)實(shí)際情況而增加； 要求與表的意義相關(guān)聯(lián)的英文字母，例如：CRM_

7、CUSTOMER。數(shù)據(jù)表大致分為：業(yè)務(wù)數(shù)據(jù)表，根據(jù)業(yè)務(wù)的實(shí)際情況來命名，如：CRM_XXX、CMS_XXX系統(tǒng)管理表: SYS_XXX工作流數(shù)據(jù)表： WF_XXX報(bào)表數(shù)據(jù)表：RP_XXX；表單自定義數(shù)據(jù)表：FD_XXX注：表名不超過 32 字符，層次深度不超過 5 層，如:：WF_AA_BB_CC_DD，這個(gè)為最大的允許深度，每張表必須要有注釋；沒有系統(tǒng)標(biāo)識(shí)的數(shù)據(jù)表為默認(rèn)的用戶（對(duì)應(yīng)的項(xiàng)目）的業(yè)務(wù)數(shù)據(jù)表。b) 字段字段/域域根據(jù)業(yè)務(wù)要求進(jìn)行命名，不需設(shè)定固定的前綴。每張表必須要有: ID NUMBER(10) not null, /主鍵 CDP VARCHAR2(50) not null, /

8、創(chuàng)建人 CDT DATE not null, /創(chuàng)建時(shí)間 EDP VARCHAR2(50), /修改人 EDT DATE, /修改時(shí)間每個(gè)字段必須要有注釋c) 索引索引 庫表設(shè)計(jì)與操作規(guī)范8/12針對(duì)數(shù)據(jù)庫表中一個(gè)或多個(gè)字段建立的索引的命名格式應(yīng)以”IDX_”開頭，索引列名間用_隔開，即為 IDX _ColumnName1_ColumnName2_；其中，ColumnName1是數(shù)據(jù)庫表中（第一個(gè)）索引字段的名稱或名稱簡(jiǎn)寫；ColumnName2 是數(shù)據(jù)庫表中（第二個(gè)）索引字段的名稱或名稱簡(jiǎn)寫；索引名的總長(zhǎng)必需符合數(shù)據(jù)庫的規(guī)定。例：idx_cert_number (表示在字段 cert_num

9、ber 上創(chuàng)建索引)為了避免重名索引出現(xiàn)，可選命名方式為 idx_ 作為索引的命名，但是要求在數(shù)據(jù)字典中進(jìn)行詳細(xì)說明d) 視圖視圖視圖的命名必須以”v_”(View 縮寫)開頭，格式為： v_系統(tǒng)標(biāo)識(shí) _。 其中，視圖類型參見”表的分類說明”；系統(tǒng)標(biāo)識(shí)_是可選項(xiàng)，依據(jù)情況而增加； 應(yīng)與視圖意義相關(guān)聯(lián)的英文字母。例：v_user_detail_infoe) 存儲(chǔ)過程存儲(chǔ)過程存儲(chǔ)過程的命名必須符合 sp_系統(tǒng)標(biāo)識(shí)_格式。其中，sp 表示是存儲(chǔ)過程；系統(tǒng)標(biāo)識(shí)為可選項(xiàng)，依據(jù)情況而增加；是與存儲(chǔ)過程意義相關(guān)聯(lián)的英文字母，例如：例：sp_check_user_auth（以動(dòng)賓方式取名）f) 觸發(fā)器觸發(fā)器觸

10、發(fā)器的的命名必須符合 tr_ 格式。 庫表設(shè)計(jì)與操作規(guī)范9/12其中，tr 表示是觸發(fā)器；是與觸發(fā)器意義相關(guān)聯(lián)的英文字母。例：tr_user_info_iu （表示對(duì) user_info 表進(jìn)行插入、更新的觸發(fā)器）g) 函數(shù)函數(shù)函數(shù)的命名必須符合 fn_系統(tǒng)標(biāo)識(shí)_格式。其中，fn 表示是函數(shù)，系統(tǒng)標(biāo)識(shí)為可選項(xiàng)，依情況而定；是與函數(shù)意義相關(guān)聯(lián)的英文字母。例：fn_create_id（以動(dòng)賓方式取名）h) 自定義數(shù)據(jù)類型自定義數(shù)據(jù)類型自定義數(shù)據(jù)類型的命名格式為：ud_ i) Default（缺?。ㄈ笔。〥efault（缺?。┑拿袷揭话銥椋篸f_；對(duì)于非綁定的默認(rèn)可取系統(tǒng)默認(rèn)的名字。j) Ch

11、eck、Constraint（約束）（約束）約束的命名格式一般為：ck_ ；一些約束可直接放在生成表的語句中。例：ck_flag，約束字段 flag 只能取字符0到9：constraint ck_flag CHECK (flag between 0 and 9 )k) Rule（規(guī)則）（規(guī)則） 庫表設(shè)計(jì)與操作規(guī)范10/12規(guī)則的命名格式一般為：rl_；對(duì)于非綁定規(guī)則(約束) 可取系統(tǒng)默認(rèn)的名字，參見第 10 點(diǎn)設(shè)計(jì)實(shí)例綁定具體字段。l) 主鍵主鍵主鍵的命名格式為 pk_。例：pk_user_info_userid （表 user_info 以字段 userid 創(chuàng)建主鍵）m) 外鍵外鍵外鍵的命

12、名格式為 fk_?？蛇x命名方式為 fk_ 作為索引的命名，但是要求在數(shù)據(jù)字典中進(jìn)行詳細(xì)說明例：fk_user_info_department_deptid （在表 user_info 的字段 department_id上創(chuàng)建外鍵，參照主表 department）n) 同義詞（同義詞（ORACLE）同義詞的命名格式為：sy_ 例：sy_user_info （為所有權(quán)屬于 ben 的表 user_info 的公共同義詞）腳本注釋腳本注釋1 存儲(chǔ)過程或觸發(fā)器存儲(chǔ)過程或觸發(fā)器 a) 每一個(gè)存儲(chǔ)過程或觸發(fā)器都要在最前面寫注釋。2 自定義函數(shù)自定義函數(shù) a)每一個(gè)自定義函數(shù)都要在其前面寫注釋。 庫表設(shè)計(jì)與

13、操作規(guī)范11/122.22.22.2 數(shù)據(jù)庫操作數(shù)據(jù)庫操作數(shù)據(jù)庫操作規(guī)范規(guī)范規(guī)范1 建立、刪除、修改庫表操作建立、刪除、修改庫表操作 確認(rèn)需做數(shù)據(jù)操作操作前的數(shù)據(jù)備份數(shù)據(jù)操作數(shù)據(jù)操作說明在開發(fā)環(huán)境中，對(duì)于自己的庫表可進(jìn)行修改、刪除操作；需要做相應(yīng)的操作前備份和操作后的登記。在進(jìn)行生產(chǎn)環(huán)境的數(shù)據(jù)操作時(shí)，必須要先做好數(shù)據(jù)備份。并需保留相應(yīng)的說明。2 添加、刪除、修改表數(shù)據(jù)添加、刪除、修改表數(shù)據(jù) 在開發(fā)環(huán)境中，開發(fā)人員所開發(fā)模塊獨(dú)自使用的庫表，可自由操作表中數(shù)據(jù)；對(duì)其他模塊關(guān)聯(lián)的庫表，應(yīng)取得其他模塊的開發(fā)人員同意后再執(zhí)行操作；系統(tǒng)的信息表、字典表的修改應(yīng)向項(xiàng)目經(jīng)理提出操作需求，由項(xiàng)目經(jīng)理執(zhí)行操作。 庫表設(shè)計(jì)與操作規(guī)范12/123 3 3 檢查清單檢查清單檢查清單命名命名規(guī)規(guī)范范重要性審查項(xiàng)審查內(nèi)容合格存儲(chǔ)空間名稱所有名稱是否用英語書寫，是否有超過 32 字節(jié)用戶名稱所有名稱是否用英語書寫，是否有超過 32 字節(jié)表、視圖等對(duì)象