規(guī)范_SQL編碼

1、文檔狀態(tài)：文檔編號(hào)： 規(guī)范_SQL編碼編 撰：編撰日期：2006-5-21保密級(jí)別：機(jī)密 Draft Released Modifing文檔版本：2.0.0SQLSQL 編碼規(guī)范編碼規(guī)范XXXXXX 信息技術(shù)公司信息技術(shù)公司 PAGE 2 OF 6SQL 編碼規(guī)范版版 本本 歷歷 史史日期日期版本版本說明說明作者作者2006-04-080.0.1初稿2006-04-301.0.0咨詢公司審計(jì)通過，正式發(fā)布2006-05-212.0.0增加系統(tǒng)集成項(xiàng)目過程 PAGE 3 OF 6SQL 編碼規(guī)范目目 錄錄1目的目的.42范圍范圍.43規(guī)范內(nèi)容規(guī)范內(nèi)容.43.1 命名規(guī)范.43.2 排版及書寫規(guī)范

2、.6 PAGE 4 OF 6SQL 編碼規(guī)范 SQLSQL 編碼規(guī)范編碼規(guī)范1目的目的為了保證所每個(gè)項(xiàng)目組編寫出的程序都符合相同的規(guī)范，便于理解和維護(hù)，便于檢查、減少出錯(cuò)概率，有助于成員間交流，保證一致性、統(tǒng)一性而建立的 SQL 程序編碼規(guī)范。2范圍范圍該規(guī)范適用于所有需要基于 SQL 開發(fā)的項(xiàng)目。3規(guī)范內(nèi)容規(guī)范內(nèi)容3.1 命名規(guī)范命名規(guī)范A.表(Table):表名用復(fù)數(shù) 比如用 Orders 而不是 Order,也不要用 tbl_*。因?yàn)楸硎且粋€(gè)集合，另外用表名用復(fù)數(shù)讓 sql 語句(比如 SELECT 的 FROM 子。B.視圖(View):1. 兩表合在一起的視圖簡(jiǎn)單的把兩個(gè)表的名字寫在

3、一起, eg. CustomersOrders2. 類似報(bào)表的簡(jiǎn)單視圖按其功能取名. eg. Summary of Sales by YearC.存儲(chǔ)過程(Stored procedures):功能模塊名(縮寫)_ + 動(dòng)詞(描述功能)_ + 名詞(多半是表名) + By + 條件，eg. ou_Get_UserByID 不要以 sp_開頭D. 函數(shù):和存儲(chǔ)過程類似.E. Triggers:觸發(fā)器是一種特殊的存儲(chǔ)過程,所以需要和存儲(chǔ)過程的命名規(guī)范區(qū)分開來.命名原則: 觸發(fā)器的存在依賴于一個(gè)表,所以比較好的做法是把表名稱包含進(jìn)來.觸發(fā)器和一個(gè)或者多個(gè)操作關(guān)聯(lián),比如 Insert,Update,D

4、elete etc. 所以也包含進(jìn)操作名稱. 有可能一個(gè)表的某個(gè)操作 PAGE 5 OF 6SQL 編碼規(guī)范有多個(gè)觸發(fā)器,所以這個(gè)時(shí)候加上觸發(fā)器的功用.eg. Orders_instrg Orders_CheckBill_updtrg Orders_insupdtrgF. Indexes:Table name + Column name(s) + Unique/Non-uniqueness + Clustered/Non-clusteredG. 字段:大寫單詞開頭:OrderIDOrderDateH. 用戶定義數(shù)據(jù)類型CustomerID_typeJ. 鍵pk_Customers_Custom

5、erIDfk_OrdersCustomerID_CustomersCustomerIDK. Default and Check 約束chk_OrderDatedef_OrderDateL. 變量1. 簡(jiǎn)潔做好2. 僅在前后綴的時(shí)候使用下劃線.其它情況大寫開頭字母3. 不要用特殊字符4. 更不要用保留字3.2 排版及書寫規(guī)范排版及書寫規(guī)范1. 大寫所有的關(guān)鍵字(保留字)2. 所有的概念對(duì)象(tables,views,procedures)大寫開頭3. 所有的標(biāo)量(column names,variables, etc.)小寫4. 一條語句一行. 在關(guān)鍵字和語句主體之間保留間隔. PAGE 6 O

6、F 6SQL 編碼規(guī)范5. 遵循 Metadata committee L8 naming conventions 6. 注意縮進(jìn)和空行7. 存儲(chǔ)過程的腳本文件一般為每個(gè)表一個(gè)段落,注明開始和結(jié)束.8. 注釋及文件框架- FileName: *.sql- Description: *模塊存儲(chǔ)過程- Author: *- Date: 2003-10-27- - Created by wangq 2003-10-27- Stored Procedure : 功能說明- Gets: UserID nvarchar(100)- Returns: *-CREATE PROCEDURE *_Get_UserByIDUser