TransactSQL数据库编程命名规范.docx

1、TransactSQL数据库编程命名规范Transact-SQL 数据库编程命名规范1. 概述1.1. 基本原则以大小写敏感编写SQL语句。尽量使用Unicode 数据类型。优先使用连接代替子查询或嵌套查询。尽量使用参数化SQL查询代替语句拼接SQL查询。禁止使用拼音+英语的方式来命名SQL对象或变量。尽量使用存储过程代替SQL语句。 1.2. 基本规范建议采用Pascal样式或Camel样式命名数据库对象。大写T-SQL语言的所有关键字，谓词和系统函数。 2. 命名规范在一般情况下，采用Pascal样式或Camel样式命名数据库对象，使在开发基于数据库应用程序的时候通过ORM工具生成的数据访

2、问代码不需要调整就符合程序开发语言（比如C#）命名规范。另外，关系型数据库同Xml结合得越来越紧密,规范的命名越来越重要。在实际数据库开发过程中，如果需求方已经提供数据库设计方案，建议以提供的方案为准；在原有数据库上进行升级开发时，在可行的情况下可适当做出设计调整以符合编程规范。 1.3. 对象命名1.3.1. 数据库第一种方式，采用Pascal样式命名，命名格式为项目英文名称。示例：AdventureWorks第二种方式，采用Pascal样式命名，命名格式为项目英文名称 + Db。示例：AdventureWorksDb BizTalkRuleEngineDb建议采用第一种方式。 1.3.2.

3、 数据库文件数据文件：数据库名称 + _Data.mdf日志文件：数据库名称 + _Log.ldf示例：AdventureWorks_Data.mdf AdventureWorks_Log.ldf 1.3.3. 关系型数据仓库采用Pascal样式命名，命名格式为项目英文名称 + DW。示例：AdventureWorksDW 1.3.4. 数据架构除SQL Server 系统定义的数据架构外，新建架构采用Pascal样式命名，命名格式为架构名。示例：HumanResources Production 对数据库对象 Table，View，Procedure，Function等使用数据架构进行归类。

4、在SQL Server 2000中dbo为默认架构。 1.3.5. 数据表采用Pascal样式命名，命名格式为表名。示例：Employee Product 表名以英文单数命名，主要是参考SQL Server 2005示例数据库，个人理解不采用复数是为了更好的使用ORM工具生成符合编程规范的代码（比如C#）。示例：使用Product 而不是Products 1.3.6. 数据视图视图名称采用Pascal样式命名，命名格式为v + 视图名称。示例：vEmployee vSalesPerson 1.3.7. 数据列列名称命名采用英文单词或缩写，英文单词只来自于具体业务定义，尽量表达清楚含义。采用Pa

5、scal样式命名，命名格式为列名称。示例：AddressID PostalCode 尽量避免使用拼音命名，如果不可避免，对于比较短的列名，采用拼音全写，如果拼音列名比较复杂，可以采用首个字用全拼，其它字用首字母大写表示。示例：宁波 Ningbo 经营方式 JingYFS 1.3.8. 存储过程建议采用Pascal样式命名，命名格式为存储过程名称。示例：GetUser AddUser 备注：在SQL Server 2005示例数据库中使用Camel样式命名。 1.3.9. 函数自定义函数采用Pascal样式命名，命名格式为函数名，系统函数使用全部大写。示例：SELECT ISNULL(LastN

6、ame,Unknown last name);GETDATE() 1.3.10. 用户定义数据类型采用Pascal样式命名，命名格式为自定义数据类型名称。示例：Flag NameStyle 1.3.11. DML触发器DML触发器是当数据库服务器中发生数据操作语言 (DML) 事件时要执行的操作。DML 事件包括对表或视图发出的 UPDATE、INSERT 或 DELETE 语句。根据事件不同命名规则使用前缀进行区分,格式为 u|i|d + 表名|视图名示例：uEmployee iEmployee dEmployee 另外一种方式为，AFTER 触发器：TR_表名_后面插入加I,修改加U,删除

7、加D。INSTEAD OF 触发器：TR_表名或视图名_OF后面插入加I,修改加U,删除加D 1.3.12. DDL触发器响应各种数据定义语言 (DDL) 事件而激发。这些事件主要与以关键字 CREATE、ALTER 和 DROP 开头的 Transact-SQL 语句对应。执行 DDL 式操作的系统存储过程也可以激发 DDL 触发器。采用Camel样式命名，命名单词能够描述DDL触发器功能。示例：CREATE TRIGGER safety ON DATABASE FOR DROP_TABLE, ALTER_TABLE AS PRINT You must disable Trigger saf

8、ety to drop or alter tables! ROLLBACK ; 另外一种方式为添加ddl前缀，示例：CREATE TRIGGER ddlDatabaseTriggerLog ON DATABASE FOR DDL_DATABASE_LEVEL_EVENTS AS 1.3.13. 主键、外键关系和索引主键: PK_表名称_主键；如果是组合主键，使用PK_表名_主键1_主键2。示例：PK_Store_CustomerID PK_StoreContact_CustomerID_ContactID外键关系：FK_从表名称_主表名称_外键列名称。示例：FK_StoreContact_St

9、ore_CustomerID 聚集索引：PK_表名称_主键；如果是组合主键，使用PK_表名_主键1_主键2。示例：PK_Store_CustomerID PK_StoreContact_CustomerID_ContactID 唯一非聚集索引:AK_表名称_列名称。示例：AK_Store_rowguid 不唯一非聚集索引：PK_表名称_列名称。示例：IX_Store_SalesPersonID 主 XML索引：PXML_表名称_Xml类型列名称。示例：PXML_Store_Demographics 备注：以上命名参考Sql Server 2005示例数据库，一般只需设计器自动生成，不需要额外修

10、改。 1.4. 参数命名1.4.1. 数据列参数命名格式为 + 列名称。示例：EmployeeID 在列名不符合Pascal样式时（早期遗留系统），例如使用全部大写的列名称，或使用“_”进行连接的字段名称，参数名称定义使用 + 列名称，这里的列名称尽量符合Pascal样式命名。 1.4.2. 非数据列参数在参数无法跟列名称进行关联时，使用能够反映该参数功能的英文单词或单词组合, 采用Pascal样式命名。示例：ErrorID Flag 1.5. 常见命名1.5.1. 常用字段命名这里的常用字段是指在建表时频繁使用的表名或列名，下表对常用字段进行建议性定义, 列名称 数据类型 说明Created

11、Date datetime 纪录创建日期，一般使用GETDATE()自动生成ModifiedDate datetime 纪录最后修改日期，首次使用GETDATE()DeletedDate datetime 记录删除（标记删除）日期StartDate datetime 开始日期EndDate datetime 结束日期StartTime datetime 开始时间EndTime datetime 结束时间rowguid uniqueidentifier 唯一标识行的ROWGUIDCOL号，用于支持合并复制ID int 使用ID代替Id或id。一般为自增长主键列ParentID int 父IDSt

12、atus int 状态 3. SQL编写3.1. 大小写大写T-SQL 语言的所有关键字，谓词和系统函数。变量名称及游标名称使用Pascal样式。数据类型定义使用全部小写。示例：DECLARE LastName nvarchar(32); 3.2. 使用“;”使用“;”作为 Transact-SQL 语句终止符。虽然分号不是必需的，但使用它是一种好的习惯。示例：USE AdventureWorks;GODECLARE find varchar(30);SET find = Man%;SELECT LastName, FirstName, PhoneFROM Person.ContactWHER

13、E LastName LIKE find; 3.3. 存储格式尽量采用Unicode数据存储格式，提高可移植性和兼容性，实际应用中尽量使用nchar、nvarchar、ntext代替char、varchar、text。 3.4. 类型选择如果字符具有明确的长度，使用nchar代替nvarchar；char代替varchar。在只有两个可能数值时，使用bit代替int或smallint。在SQL Server 2005中，使用nvarchar(MAX)代替ntext；varchar(MAX)代替text；varbinary(MAX)代替image。在特殊的数据表结构中可考虑xml数据类型，达到事

14、半工倍的效果。 3.5. 默认值在建立数据表时，尽量使用默认值代替NULL值。比如设置CreatedDate列默认值为GETDATE()。在可行的情况下设置字段为不允许空。 3.6. 字段长度始终指定字符数据类型的长度，并确保允许用户可能需要的最大字符数，避免超出最大长度时出现字符丢失现象。对于字符型数据，建议采用2的n次方来定义数据长度。示例：nvarchar(32) varchar(64) 3.7. 使用“”在 T-SQL 代码中为字符常量使用单引号,避免使用双引号。 3.8. 语句缩进一个嵌套代码块中的语句使用四个空格的缩进。使用Microsoft SQL Server Management Studio ,选择“工具”菜单，打开“选项”菜单，在选项对话框中选择文本编辑器-纯文本-制表符,选中“插入空格单选框”,设置“制表符大小”为4，缩进大小为“4”。 3.9. 语句换行建议SQL代码每行以关键字或“”开头。示例：SELECT ShiftID ,Name ,StartTime ,EndTime ,ModifiedDate FROM AdventureWorks.HumanResources.Shift 3.10. 语句分割使用一个（而不是两