DBA!你也能写出优雅的SQL脚本

数据库 SQL Server
在这里,我们想告诉各位DBA们。其实您也可以写出优雅的SQL脚本,本文将给您一些中肯的建议。

本篇来聊聊如何书写漂亮、整洁、优雅的SQL脚本,下面这些是我个人总结、整理出来的。姑且做个抛砖引玉吧,呵呵,欢迎大家一起来讨论。

我们首先来看看一段创建数据表的脚本(如下所示),你是否觉得有什么不妥或是不足呢?如果是你,你怎样书写呢?

  1. CREATE TABLE [dbo].[TableDataDictionary](  
  2.     [TableID] [int] IDENTITY(1,1) NOT NULL,  
  3.     [IpAddress] [nvarchar](15) NOT NULL,  
  4.     [DataBaseName] [nvarchar](35) NOT NULL,  
  5.     [TableName] [nvarchar](35) NOT NULL,  
  6.     [Description] [nvarchar](150) NULL,  
  7.  CONSTRAINT [PK_TableDataDictionary] PRIMARY KEY([Tableid])  

可能你也没有觉得它有什么不妥,因为你一直都是这样书写哦。而且更混乱、更杂的的脚本你也见过,也可能习惯了;那么来看看下面的脚本,

  1. USE [Test];  
  2. GO  
  3.  
  4. IF OBJECT_ID(N'TableDataDictionary'IS NULL   
  5.     CREATE TABLE [dbo].[TableDataDictionary]  
  6.     (  
  7.         [TableID]            INT IDENTITY(1,1)  NOT NULL,  
  8.         [IpAddress]          NVARCHAR(15)       NOT NULL,  
  9.         [DataBaseName]       NVARCHAR(35)       NOT NULL,  
  10.         [TableName]          NVARCHAR(35)       NOT NULL,  
  11.         [Description]        NVARCHAR(150)      NULL,  
  12.         CONSTRAINT [PK_TableDataDictionary] PRIMARY KEY([Tableid])  
  13.     );  
  14. ELSE 
  15.     PRINT 'This table have been exist in database';  
  16. GO 

上面两段脚本比起来,你是否觉得下面的更美观、优雅呢?

接下来我们来看看四段申明变量的脚本,自己可以对比

(一)

  1. DECLARE @PayType VARCHAR(50),  @Rate FLOAT, @FeeRate FLOAT ,@OtheFee FLOAT;  
  2. DECLARE @StartDate DATETIME,   @EndDate DATETIME;  
  3. DECLARE @CmdSql NVARCHAR(MAX);  
  4. DECLARE @MyCardBillFee FLOAT, @MyCardFee    FLOAT

---------------------------------------------------------------------------------------------------------

(二)

  1. DECLARE @PayType VARCHAR(50);  
  2. DECLARE @Rate FLOAT;  
  3. DECLARE @FeeRate FLOAT;  
  4. DECLARE @OtheFee FLOAT;  
  5. DECLARE @StartDate DATETIME;  
  6. DECLARE @EndDate DATETIME;  
  7. DECLARE @CmdSql NVARCHAR(MAX);  
  8. DECLARE @MyCardBillFee FLOAT;  
  9. DECLARE @MyCardFee    FLOAT

---------------------------------------------------------------------------------------------------------

(三)

  1. DECLARE @PayType         VARCHAR(50);              --支付类型  
  2. DECLARE @Rate            FLOAT;                    --汇率比例  
  3. DECLARE @FeeRate         FLOAT;                    --手续费比例  
  4. DECLARE @MyCardFee       FLOAT;                    --......  
  5. DECLARE @OtheFee         FLOAT;                    --......  
  6. DECLARE @MyCardBillFee   FLOAT;                    --......  
  7. DECLARE @StartDate       DATETIME;                 --......  
  8. DECLARE @EndDate         DATETIME;                 --......  
  9. DECLARE @CmdSql          NVARCHAR(MAX);            --...... 

--------------------------------------------------------------------------------------------------------

(四)

  1. DECLARE   
  2.     @PayType         AS    VARCHAR(50);            --支付类型  
  3.     @Rate            AS    FLOAT;                  --汇率比例  
  4.     @FeeRate         AS    FLOAT;                  --手续费比例  
  5.     @MyCardFee       AS    FLOAT;                  --......  
  6.     @OtheFee         AS    FLOAT;                  --......  
  7.     @MyCardBillFee   AS    FLOAT;                  --......  
  8.     @StartDate       AS    DATETIME;               --......  
  9.     @EndDate         AS    DATETIME;               --......  
  10.     @CmdSql          AS    NVARCHAR(MAX);          --...... 

-------------------------------------------------------------------------------------------------------

如果是你,你愿意运用哪种书写格式呢? 个人觉得(一)写得极极糟糕,不仅阅读不方便、而且也不方便注视。(二)则是我以前习惯书写的格式,一来没有注视、二来看起来没有(三)、(四)美观、大方。

存储过程、函数头部注视的样式(个人曾今用过的样式):

(一)

--======================================================================================

  1. --       Function         :            dbo.USP_GetEmployeById 按Id获取雇员信息  
  2. --       Auhtor            :            Kerry  
  3. --       Create Date       :            2010-08-12  
  4. --       Description       :            详细描述存储过程功能(对Function 功能补充)、以及参数、输出结果的描述 

--======================================================================================
--            2010-08-12        :           修改....增加........
--            2010-08-13        :            修改....增加.......
--=====================================================================================

Function  简要描述存储过程、函数功能。

Desctiption 详细描述存储过程、函数功能,以及参数、输出结果描述

 (二)

--======================================================================================

  1. --        Create Date            :        2010-08-11  
  2. --        Author                 :        Kerry  
  3. --        Modified Date          :        2010-08-12  
  4. --        Modified Content       :        修改表字段、增加汇率计算.....  
  5. --        Modified Date          :        2010-08-13  
  6. --        Modified Content       :        修改表字段、增加汇率计算.....  
  7. --        Description            :        计算抢车位社区游戏的月充值结构信息。     

--=======================================================================================

 (三)

  1. /**************************************************************************************************************  
  2.         Auhtor                 :            Kerry  
  3.         Create Date            :            2010-08-12  
  4.         Modified Date          :  
  5.         Modified Content       :  
  6.         Description            :            如何书写漂亮、优雅的SQL脚本  
  7. **************************************************************************************************************/ 

  ( 四)

  1. -- =============================================  
  2. -- Author:        <Author,,Name>  
  3. -- Create date: <Create Date,,>  
  4. -- Description:    <Description,,>  
  5. -- ============================================= 

使用MSSMS新建存储过程,它自动生成的样式

个人觉得(一) >= (二) > (三) > (四) ,不知道大家有没有更好的格式推荐。

下面看看这样一段脚本,一眼就觉得有点糟糕,其实实际开发中脚本比这个可能复杂得多,头痛吧

  1. select PermissionID from  Permission where resourceid=  
  2. select top 1 resourceid from [Resource] where resourcename=@resourcename) and   
  3. actionid=(select top 1 actionid from [Actionwhere actionname=@actionname)  
  4. AND SchemaId in (SELECT SchemaId FROM dbo.BindToSchema WHERE DcUserID=@UserID)     

首先就应该统一关键字大小写,不要一部分大写、一部分小写。然后从结构上面调整。 可能每个人的审美观、习惯的格式不同,这个无所谓,也没有必要统一。 但是你书写出来的脚本至少要结构清晰,一目了然。不要让别人费很大的劲去调整格式,然后才能理解它的逻辑,如果写出上面或是比上面更糟糕的脚本,我想项目经理真应该教训教训你。这样只会给后来维护的人痛苦不堪(实际开发中可能比这糟糕十倍呢,想必很多人是深受其害啊)

  1. SELECT Permission FROM  Permission  
  2.  WHERE   
  3.      resourceid =( SELECT TOP 1 resourceid FROM [Resource] WHERE resourcename=@resourcename)   
  4.     AND actionid =(SELECT TOP 1 actionid FROM [ActionWHERE actionname=@actionname)  
  5.     AND SchemaId IN (SELECT SchemaId FROM dbo.DcUserBindToSchema WHERE DcUserID=@UserID) 

动态组合语句是否让你的脚本看起来林乱不堪啊,你有没有试过让其在某些方面看起来美观点、优雅点啊、

  1. 'SELECT   Order_ID = @OrderID, CampaignCode= @CampaignCode, ProductCode = @ProductCode, StartDate= SpotDate,    
  2.    EndDate = EndDate, StartTime= Media_StartTime, EndTime = Media_EndTime, Duration = (CASE WHEN Media_Duration IS NULL OR   ELSE Media_Duration END), Adformat= Media_Adformat , Color = Media_Color , --Media_Showing,                                          Size   = Media_Size, SpotType  = Media_SpotType, URL = Media_URL  , ScheduleNo   = ScheduleNo ,   
  3.    Plan_Insertion_ID  = Plan_Insertion_ID  

那下面书写格式是不是美观、整洁些呢

  1. SELECT     
  2.   Order_ID          = @OrderID    
  3. , CampaignCode      = @CampaignCode    
  4. , ProductCode       = @ProductCode    
  5. , StartDate         = SpotDate    
  6. , EndDate           = EndDate    
  7. , StartTime         = Media_StartTime    
  8. , EndTime           = Media_EndTime     
  9. , Adformat          = Media_Adformat                                         
  10. , Color             = Media_Color    
  11. , Impression        = Media_Impression                                       
  12. , Location          = Media_Location                                         
  13. , Material          = Media_Material                                         
  14. , Position          = Media_Position                                         
  15. , Program           = Media_Program                                          
  16. , Scale             = Media_Scale         --Media_Showing                                          
  17. Size              = Media_Size                                             
  18. , SpotType          = Media_SpotType                                      
  19. , URL               = Media_URL    
  20. , ScheduleNo        = ScheduleNo    
  21. , Plan_Insertion_ID = Plan_Insertion_ID    
  22. , Position = Media_Position  

怎么样是否觉得下面的”清新脱俗“,眼前一亮啊,呵呵,不是在说美女啊。看看我以前一个同事写的吧,我只截取了一部分。

 

写着觉得有点天马行空、不着边际了,其实这个话题有点大,而且和个人习惯、审美观有莫大联系,所谓众口难调,不过有几点应该是一致的:

1:书写脚本的时候,多用空格、Tab键,不要让代码拥挤,杂糅在一起。

2:让代码看起来觉得舒服,一目了然,不要一看就觉得头痛,要细细看上好久,才了解逻辑结构

3:让代码看起来整洁、优美。凌乱不堪是大忌。

4:总结、学习一些书写漂亮的格式。

限于篇幅,下面给出一些我见过的、写的比较优雅的脚本,大家也可以贴出自己写得优美的代码,一起学习探讨。、

 

  1. -- Construct column list  
  2. SET @sql =  
  3.   N'SET @result = '                                    + @newline +  
  4.   N'  STUFF('                                          + @newline +  
  5.   N'    (SELECT N'','' + ' 
  6.            + N'QUOTENAME(pivot_col) AS [text()]'       + @newline +  
  7.   N'     FROM (SELECT DISTINCT(' 
  8.            + @on_cols + N') AS pivot_col'              + @newline +  
  9.   N'           FROM' + @query + N') AS DistinctCols'   + @newline +  
  10.   N'     ORDER BY pivot_col'                           + @newline +  
  11.   N'     FOR XML PATH('''')),'                         + @newline +  
  12.   N'    1, 1, N'''');' 
  13.  
  14. EXEC sp_executesql  
  15.   @stmt   = @sql,  
  16.   @params = N'@result AS NVARCHAR(MAX) OUTPUT',  
  17.   @result = @cols OUTPUT;  
  18.  
  19. -- Create the PIVOT query  
  20. SET @sql =  
  21.   N'SELECT *'                                           + @newline +  
  22.   N'FROM'                                               + @newline +  
  23.   N'  ( SELECT '                                        + @newline +  
  24.   N'      ' + @on_rows + N','                           + @newline +  
  25.   N'      ' + @on_cols + N' AS pivot_col,'              + @newline +  
  26.   N'      ' + @agg_col + N' AS agg_col'                 + @newline +  
  27.   N'    FROM '                                          + @newline +  
  28.   N'      ' + @query                                    + @newline +  
  29.   N'  ) AS PivotInput'                                  + @newline +  
  30.   N'  PIVOT'                                            + @newline +  
  31.   N'    ( ' + @agg_func + N'(agg_col)'                  + @newline +  
  32.   N'      FOR pivot_col'                                + @newline +  
  33.   N'        IN(' + @cols + N')'                         + @newline +  
  34.   N'    ) AS PivotOutput;' 

代码

  1. DECLARE 
  2.   @schemaname AS NVARCHAR(128),  
  3.   @tablename  AS NVARCHAR(128),  
  4.   @colname    AS NVARCHAR(128),  
  5.   @sql        AS NVARCHAR(805);  
  6.  
  7. SET @schemaname = N'dbo';  
  8. SET @tablename  = N'Orders';  
  9. SET @colname    = N'CustomerID';  
  10. SET @sql = N'SELECT COUNT(DISTINCT ' 
  11.   + QUOTENAME(@colname) + N') FROM ' 
  12.   + QUOTENAME(@schemaname)  
  13.   + N'.' 
  14.   + QUOTENAME(@tablename)  
  15.   + N';';  
  16.  
  17. EXEC(@sql); 

原文标题:如何书写优雅、漂亮的SQL脚本?

链接:http://www.cnblogs.com/kerrycode/archive/2010/08/16/1800334.html

【编辑推荐】

  1. SQL server定时执行脚本的操作流程
  2. 浅谈如何在SQL Server中生成脚本
  3. Oracle数据库管理脚本浅析
  4. 如何实现SQL Server临时表的创建?
  5. 实现SQL Server动态游标的创建步骤  

 

责任编辑:彭凡 来源: 博客园
相关推荐

2018-07-12 14:20:33

SQLSQL查询编写

2020-08-04 09:11:47

架构师垃圾代码

2022-07-08 14:35:05

Java组件LiteFlow

2020-11-12 09:45:16

前端开发代码

2017-12-12 15:42:39

Monkey脚本MS

2022-02-21 08:00:23

开发代码程序员

2018-04-09 11:10:04

PHP前端控制器自动加载

2011-04-19 17:09:52

代码编程

2022-03-11 12:14:43

CSS代码前端

2019-09-20 15:47:24

代码JavaScript副作用

2021-10-11 08:08:02

Python异常程序

2021-01-04 07:57:07

C++工具代码

2011-01-24 08:01:06

SQL语句

2019-12-24 10:40:53

Java代码编程

2024-03-28 14:29:46

JavaScript编程

2024-12-04 15:10:21

2023-11-02 09:02:55

Java模式

2020-08-05 08:26:28

SQLDBA MySQL

2020-05-27 10:35:16

SQLDBA 索引

2020-04-26 19:12:29

shell脚本Linux
点赞
收藏

51CTO技术栈公众号