Sql Server-语法规范

起因：

今天整理了一下公司的部分Sql Server脚本，发现有很多都是不合规范的，最大的一个问题就是，不标注是否可重复执行，可重复执行的脚本有严重不合规范的漏洞

出现问题：

• 未标注是否可重复执行，可重复执行的脚本重复执行出错
• 脚本语法和排版参差不齐
• 命名未按规范命名
• 语法逻辑有漏洞

总结一下比较常用的Sql Server语法规范

---

一、注释

首先是注释的方法：

--这个是注释

/* 这个也是注释
    CN01    一般纳税货品增值税（17%）  17
    CN02    一般纳税税率（13%） 13
    CN03    零税率税目   0.00000000
    CN04    一般货物出口增值税   0.00000000
    CN05    3%税率    3
    CN06    5%税率    5
    CN07    6%税率    6
    CN08    11%税率   11
    CN09    一般纳税商品16%   16
    CN10    税率1.5%  1.5
    CN11    税率10%   10
    CN12    税率9%    9
    ZERO    税率0%    0
*/

这是两种为Sql Server注释的语法，在Sql Server中，注释也是必不可少的，越是复杂的脚本越要注释，语法简单，简短，容易理解的脚步就不需要太多注释了，因为注释过多也是会影响脚本可读性的：

• 在每个重要的逻辑转换或判断处
• 脚本的执行注意事项例如是否可重复执行、是否涉及插入和删除数据、备份什么表后再执行
• 脚本的创建人，创建时间，目的；修改人，修改时间，目的

二、表的创建

在创建表之前需要判断是否存在表，存在则DROP TABLE；当然也可以不存在此表则创建，存在则跳过且直接往下执行。只要先做判断，不出现执行脚本报错的问题即可

/*初始化脚本，建表前判断，若已存在该表则DROP TABLE后再新建*/
IF EXISTS (SELECT 1 FROM sysobjects WHERE id = object_id('TableName') AND type = 'U')
    DROP TABLE TableName
GO
/*==============================================================*/
/* Table: TableName                                             */
/*==============================================================*/
create table TableName (
   ID                   int                  identity,
   Code                 nvarchar(50)         null,
   Name                 nvarchar(50)         null,
   Remark               nvarchar(500)        null,
   CUserID              int                  not null,
   CUserName            nvarchar(50)         not null,
   CDate                datetime             null,
   constraint PK_TableName primary key (ID)
)
go
/*约束，需要先有UserInfo表才可以执行以下约束添加*/
ALTER TABLE TableName
    ADD CONSTRAINT FK_TableName_FK_UserInfo FOREIGN KEY (CUserID)
        REFERENCES UserInfo (UserID)
GO

三、表中字段添加

对已存在的表添加字段的时候

/*对TableName表加入字段IsEnable*/
IF  EXISTS (SELECT * FROM dbo.sysobjects WHERE id = OBJECT_ID(N'[dbo].[TableName]') AND TYPE in (N'U'))
 BEGIN
   IF (NOT exists ( SELECT * FROM dbo.syscolumns WHERE name = 'IsEnable' and id in 
      (SELECT id FROM dbo.sysobjects WHERE id = object_id(N'[dbo].[TableName]') and OBJECTPROPERTY(id, N'IsUserTable') = 1))
      ) 
   BEGIN
     ALTER TABLE [dbo].[TableName] ADD [IsEnable]  BIT null
   END
 END
Go

需要删除表中某个字段的时候，需要区分是否存在对此字段的约束或者引用，有约束需要先删除约束，有外键引用需要先把外键先删除
注意：不建议随便对表字段或数据删除操作做成脚本！！这些操作之前都应该备份好表数据！！

IF  EXISTS (SELECT * FROM dbo.sysobjects WHERE id = OBJECT_ID(N'[dbo].[TableName]') AND TYPE in (N'U'))
    BEGIN
        IF (exists ( SELECT * FROM dbo.syscolumns WHERE name = 'IsEnable' and id in (SELECT id FROM dbo.sysobjects WHERE id = object_id(N'[dbo].[TableName]') and OBJECTPROPERTY(id, N'IsUserTable') = 1)) ) 
        BEGIN
            /*删除没有默认值的列*/
            ALTER TABLE [dbo].[TableName] DROP COLUMN IsEnable
        END
        IF (exists ( SELECT * FROM dbo.syscolumns WHERE name = 'CUserID' and id in (SELECT id FROM dbo.sysobjects WHERE id = object_id(N'[dbo].[TableName]') and OBJECTPROPERTY(id, N'IsUserTable') = 1)) ) 
        BEGIN
            /*删除有默认值的列：先删除约束（默认值）,然后在删除列*/
            ALTER TABLE [dbo].[TableName] DROP CONSTRAINT FK_TableName_FK_mrBaseInf
            ALTER TABLE [dbo].[TableName] DROP COLUMN CUserID
        END
    END
Go

四、存储过程

存储过程的创建一定要先判断是否已存在存储过程，存储过程的主体结束以后，一定要在最后加入一个GO

IF  EXISTS (SELECT * FROM dbo.sysobjects WHERE id = OBJECT_ID(N'[dbo].[UserInfoAdd]') AND type in (N'P', N'PC'))
    DROP PROCEDURE [dbo].[UserInfoAdd]
GO
CREATE PROCEDURE [dbo].[UserInfoAdd]
    @UserID int,
    @UserName varchar(2000)
AS
    insert [dbo].[TableName](CUserID,CUserName) values(@UserID,@UserName)
GO

五、函数

函数的创建一定要先判断是否已存在函数，同样要在最后加入一个GO

IF exists(SELECT * FROM sysobjects WHERE name='GetName' and Type='FN')
   DROP FUNCTION [dbo].[GetName]
Go
Create FUNCTION [dbo].[GetNameByID](@ID INT)  
    RETURNS nvarchar(210)  
AS
    BEGIN
        DECLARE @Names NVARCHAR(210)    
        SELECT @Names=Name FROM [dbo].[TableName] WHERE ID=@ID  
        RETURN @Names
    End
Go

六、脚本命名

2020-04-01-1343-Name
这样子命名的好处是在合并当前年份脚本的时候就可以按照时间顺序合并了