SQLServer数据库设计命名规范.docx
《SQLServer数据库设计命名规范.docx》由会员分享,可在线阅读,更多相关《SQLServer数据库设计命名规范.docx(13页珍藏版)》请在冰豆网上搜索。
![SQLServer数据库设计命名规范.docx](https://file1.bdocx.com/fileroot1/2023-2/8/8a12bf8e-8fb3-4086-b08b-5e8659ba87c0/8a12bf8e-8fb3-4086-b08b-5e8659ba87c01.gif)
SQLServer数据库设计命名规范
SQLServer数据库设计规范
1相关的设计规范
1.1采用有意义的字段名
尽可能地把字段描述的清楚些。
当然,也别做过头了,比如CustomerShippingAddressStreetLine1虽然很富有说明性,但没人愿意键入这么长的名字,具体尺度就在你的把握中。
每个单词的首个字母要求用大写!
!
!
不要用下划线来连接每个单词。
1.2遵守3NF标准3NF规定:
A.表内的每一个值都只能被表达一次。
B.表内的每一行都应该被唯一的标识(有唯一键)。
C.表内不应该存储依赖于其他键的非键信息。
1.3小心保留词
要保证你的字段名没有保留词、数据库系统或者常用访问方法冲突,比如,写的一个ODBC连接程序里有个表,其中就用了DESC作为说明字段名。
后果可想而知!
DESC是DESCENDING缩写后的保留词。
表里的一个SELECT*语句倒是能用,但我得到的却是一大堆毫无用处的信息。
1.4保持字段名和类型的一致性
在命名字段并为其指定数据类型的时候一定要保证一致性。
假如字段在某个表中叫做“AgreeMentNumber”,你就别在另一个表里把名字改成“ref1”。
假如数据类型在一个表里是整数,那在另一个表里可就别变成字符型了。
记住,你干完自己的活了,其他人还要用你的数据库呢。
2命名规则:
2.1数据库(Database)的定义
数据库名称=数据库内容标识(首字大写)
2.2表(Table)的定义
命名应尽量反映存储的数据内容。
表名前缀:
以该表及与该表相关联的一系列表的内容而得到一个代表统一的标识
表名称=表名前缀+表内容标识(首字大写)
如ClientInfo相关联的一系的表以ci作为前缀,
即有表名:
ciHistory,ciContact,ciBusiness
2.3字段(Field)的定义
字段是数据库中的用途最广泛的,它的类型非常多,所以必须加类型前缀来标示它的类型。
字段名称=字段类型前缀+字段内容标识(首字大写)
2.4视图名
视图的名称="vw"+视图内容标识(首字大写)
如vUserPerm
2.5触发器名
触发类型触发标识
-----------------------------------
Inserti
Deleted
Updateu
触发名="tr"+触发标识+相应的表名
如:
triClient,trdClient。
2.6存储过程名
存储过程功能存储过程功能前缀
----------------------------------------
添加a
更新u
删除d
查询或其它o
存储过程名称=存储过程功能前缀+存储过程内容标识(首字大写)
如spoChkUserPerm
2.7变量名
每个单词的首个字母为大写,如@EmployeeName。
2.8命名中其他注意事项
禁止使用中文命名!
!
!
!
!
命名都不得超过30个字符的系统限制,变量名的长度限制为29(不包括标识字符@)。
命名都采用英文字符,每个单词的首个字母要大写
2.9SQL语句的编写规范
数据库中存储过程和触发器中涉及大量的SQL语句,对SQL语句的编写规范如下:
关键字大写:
在SQL语句的编写中,凡是SQL语句的关键字一律大写,如:
SELECT、ORDERBY、GROUPBY、FROM、WHERE、UPDATE、INSERTINTO、SET、BEGIN、END......
2.10Rule
ru+Rule标识
2.11主键
pk+表名+主键标识
2.12外键
fk+表名+主表名+外键标识
2.13索引
idx+字段标识
2.14Default
df+Default标识
3编程结构和描述
SQLSERVER系统中,一个批处理是从客户传给服务器的一个完整的包,可以包含若干条SQL语句。
批处理中的语句是作为一组去进行语法分析、编译和执行的。
触发器、存储过程等数据对象则是将批处理永久化的方法。
3.1注释
注释可以包含在批处理中。
在触发器、存储过程中包含描述性注释将大大增加文本的可读性和可维护性。
本规范建议:
1、注释以英文为主。
实际应用中,发现以中文注释的SQL语句版本在英文环境中不可用。
为避免后续版本执行过程中发生某些异常错误,建议使用英文注释。
2、注释尽可能详细、全面。
创建每一数据对象前,应具体描述该对象的功能和用途。
传入参数的含义应该有所说明。
如果取值范围确定,也应该一并说明。
取值有特定含义的变量(如boolean类型变量),应给出每个值的含义。
3、注释语法包含两种情况:
单行注释、多行注释
单行注释:
注释前有两个连字符(--),最后以行尾序列(CR-LF)结束。
一般,对变量、条件子句可以采用该类注释。
多行注释:
符号/*和*/之间的内容为注释内容。
对某项完整的操作建议使用该类注释。
4、注释简洁,同时应描述清晰。
3.2函数注释:
编写函数文本--如触发器、存储过程以及其他数据对象--时,必须为每个函数增加适当注释。
该注释以多行注释为主,主要结构如下:
/*******************************************************************************************
*存储过程:
读取用户所分配的操作模块及具体权限
*编制者:
saiko
*修改人:
*编制日期:
2004.11.27
*输入参数:
共有2个参数
*@cUserNo:
用户编号
*@cUserPassword:
验证密码
*输出参数:
@eResult1.成功=销售@00012.失败=Null3.与@eResult无关输出是记录集
*调用例子:
declare@eResultvarchar(50)execuChkUserPerm'0755','123456','销售'
*说明:
*
******************************************************************************************/
CREATEPROCEDUREspoxxx
…
3.3条件执行语句if…else
条件语句块(statenemtblock,以begin…end为边界)仅在if子句的条件为真时才被执行。
为提高代码的可读性,建议嵌套不多于5层。
还有,当嵌套层次太多时,应该考虑是否可以使用case语句。
3.4重复执行while和跳转语句goto
需要多次执行的语句,可以使用while结构。
其中,控制while循环的条件在任何处理开始之前需要先执行一次。
循环体中的保留字break无条件的退出while循环,然后继续处理后续语句;保留字continue重新计算while条件,如果条件为真,则从循环开始处重新执行各语句。
使用跳转语句goto和标签label也可以方便地实现循环和其他更灵活的操作。
SQLSERVER仅具有单通道语法分析器,因此不能解析对尚未创建的对象所做的前向参考。
换言之,跳转到某标签的后续语句应该是可执行的(如不存在可能尚未创建的数据对象)。
3.5书写格式
数据库服务器端的触发器和存储过程是一类特殊的文本,为方便开发和维护,提高代码的易读性和可维护性。
规范建议按照分级缩进格式编写该文本。
顺序执行的各命令位于同一级;条件语句块(statenemtblock,以begin…end为边界)位于下一级,类推。
SQL语句是该文本的主体。
为适应某些教复杂的用户需求,SQL语句可能比较庞大。
为方便阅读和维护,规范建议按照SQL语句中系统保留字的关键程度再划分为三级。
具体分级请参照下表。
其中,非系统保留字(如字段名、数据表名、标点符号)相对本级保留字再缩进一级。
多个连续的非保留字可以分行书写,也可以写在同一行。
当WHERE包含的条件子句教复杂时,应该每行只写一个条件分句,并为重要的条件字句填写单行注释。
在保证基本缩进格式的前提下,可以通过对齐某些重要关键字(如条件关键字AND、OR,符号=、等)来进一步提高文本的易读性和可维护性。
相邻两级的缩进量为10个空格。
这也是ISQL编辑器默认的文本缩进量。
另外,在ISQL编辑器中,一个TAB键也相当于10个空格。
注:
按照功能,四类SQL语句(SELECT、INSERT、UPDATE、DELETE)的关键字可以划分为三类:
主关键字、次关键字、一般关键字。
如下表所示:
主关键字次关键字一般关键字
SELECTINSERT(INTO)UPDATEDELETEFROMWHEREVALUESINSERT…SELECT…FROM语句中的SELECT和FROMANDORBETWEENINLIKE
3.6字体
系统保留字应大写,包括系统公共变量等。
其他字符(如用户自定义变量、用户自定义数据对象名)小写。
需要特殊强调的部分可以大写。
一条完整注释语句的首字符应大写。
对某变量、某条件字句的注释可以全部使用小写。
通过下一节中生成表r_a的删除触发器的实例可以部分说明对象命名、注释、基本书写格式和字符大小写方面的一些注意事项。
4触发器编程规范
4.1范例
下面通过一个例子,说明触发器编程中应遵守的规范:
/*deleterelatedr_aaccordingtodeletedtable*/
CREATETRIGGERr_a_dONr_a
FORDELETE
AS
IF@@ROWCOUNT=0-norowsdeleted
RETURN
/*deleter_btablerelatedtodeletedtable*/
DELETEr_b
FROMr_bb,deletedd
WHEREb.id=d.id
IF@@ERROR!
=0
BEGIN
RAISERROR("Erroroccurreddeletingrelatedrecords",16,1)
ROLLBACKTRAN
END
RETURN
数据库设计规范
A.表命名规则
数据库中不论是表名还是字段名,都一律用英文,不准出现其它语言;且保留原来的字段名,保留它们的规范;
为了不增加数据库当中的表名的长度,一般不允许出现如Form或者Table的字样,如:
记录表:
应为Record,而不是RecordTable
数据库当中的表名的命名,一般不准出现空格,假如有几个单词出现的话,每个单词之间不允许留有空格,用”_”隔开如人事信息表:
应为Human_Info,而不是HumanInfo;每个单词的第一个字母必须大写;如果太长,为了不增加编程的难度可采用缩写的方式,每个单词可取三到四个字母表示,也可根据实际情况,实际习惯进行缩写
B.列命名规则
表中的字段名的命名方式与表名的命名方式一致,只是不需要模块的前缀,但是为了编程的方便性,可在前面加上字段类型的前缀,一般取用类型的三个字母,但是不需要下划线,而且这三个字母必须小写;如姓名字段为字符型的话就应该为chrName;尝用字段类型的缩写可参考下面的表格:
缩写类型
chrchar
nvrnvarchar
numnumeric
fltfloat
dtmdatetime
intInt(integer)
mnymoney
imgimage
txttext
relreal
ntxntext
C.数据库对象命名规则
命名规则为:
对象类型+变量的含义
数据库对象命名可归纳如下:
对象前缀示例
表无Sales_Reps
列数据类型intAuthorId
视图[View]vwvwContractAuthors
存储过程[StoreProcedure]prcprDeleteTerminatedReps
规则[Rules]rlrlZipCheck
默认[Default]dfdfStandardQuanity
用户自定义数据类型dtdtAddressLine
用户自定义功能fnfnParser
索引(聚集)icicAuthorFullName
索引(非聚集)ininClientStateCity
主键(聚集)pcpcCustomerId
主键(非聚集)pkpnSstateLookupId
外键[ForeignKey]fkfkRepCompanyId
触发器[Trigger]trtrStoreDelete
游标[Cursor]crcrTables
D.特殊规则
在字段的类型上面,为了不因为系统的设置而造成编程上面的问题,所以只要是日期类型,一般都用字符型来代替,其长度不应该小于10位,而且存储格式统一,如2002-07-15。
为了避免在以后的编程以及字体差异方面带来不利,因此只要是能下拉的字段一般都指定统一的编码,可以取用数字型来代替,但必须注明每个数字代表的意思;如性别字段:
可以采用数字代替的方式,1:
代表男,0:
代表女;而且要在字段后面的备注栏中填写清楚。
5命名(规范)的约定
1.数据库涉及字符规范
我们约定:
采用26个英文字母(区分大小写)和0-9这十个自然数,加上下划线_组成,共63个字符。
不能出现其他字符(注释除外)。
2.数据库对象命名规范
我们约定,数据库对象包括表、视图(查询)、存储过程(参数查询)、函数、约束。
对象名字由前缀和实际名字组成,长度不超过30。
前缀:
使用小写字母
表tb
视图vi
存储过程sp
函数fn
实际名字:
实际名字尽量描述实体的内容,由单词或单词组合,每个单词的首字母大写,其他字母小写,不以数字和_开头。
如
表User_Info
视图User_List
存储过程User_Delete
因此,合法的对象名字类似如下。
表tbUser_InfotbMessage_Detail
视图vi_Message_List
存储过程sp_Message_Add
3.数据库表命名规范
我们约定,表名由前缀和实际名字组成。
前缀:
使用小写字母tb,代表表。
实际名字中,一个系统尽量采取同一单词,多个后面加_来连接区分。
因此,合法的表名类似如下。
tbMember
tbMember_Info
tbForum_Board
tbBlog_Comment1
4.字段命名规范
我们约定,字段由表的简称,实际名字组组成。
如果此字段关联另外的字段,那么加下划线_连接关联表字段的字段名。
因此,合法的字段名类似如下。
UserID_MeID
UserName
UserRegDate
5.视图命名规范
我们约定,字段由前缀和实际名字组成,中间用下划线连接。
前缀:
使用小写字母vi,表示视图。
因此,合法的视图名类似如下。
vi_User
vi_UserInfo
6.存储过程命名规范
我们约定,字段由前缀和实际名字加操作名字组成,中间用下划线连接。
前缀:
使用小写字母sp,表示存储过程。
操作名字:
Insert|Delelte|Update|Caculate|Confirm
例如:
sp_User_Insert
7.数据库设计文档规范
所有数据库设计要写成文档,文档以模块化形式表达。
大致格式如下:
'-------------------------------------------
'表名:
tbUser_Info
'作者:
Yezi(叶子)
'日期:
2004-12-17
'版本:
1.0
'描述:
保存用户资料
'具体内容:
'UserIdint,自动增量用户代码
'UserNamechar(12)用户名字
'......
'--------------------------------------------
8.sql语句规范
我们约定,所有sql关键词全部大写,比如SELECT,UPDATE,FROM,ORDER,BY等。
...