Skip to content

Latest commit

 

History

History
632 lines (530 loc) · 19.6 KB

tsql_standart.md

File metadata and controls

632 lines (530 loc) · 19.6 KB
Raw

Стандарт оформления T-SQL

версия 1.0.5.2

Имена объектов

Объект Длина Префикс Допустимые символы Пример
Database 30 [A-z] MyDatabase
Schema 30 [A-z][0-9] MySchema
Database Trigger 50 DTR_ [A-z] DTR_CheckLogin
File Table 128 FT_ [A-z][0-9] FT_MyTable
Global Temporary Table 128 ##[A-z][0-9] ##MyTable
Local Temporary Table 128 #[A-z][0-9] #MyTable
Table 30 [A-z][0-9] MyTable
Table Column 30 [A-z][0-9] MyColumn
Table Default Values 128 DF_ [A-z][0-9] DF_MyTable_MyColumn
Table Check Column Constraint 128 CK_ [A-z][0-9] CK_MyTable_MyColumne

Завершайте каждый оператор в задании точкой с запятой

Признак конца инструкции Transact-SQL. Хотя точка с запятой не требуется для большинства инструкций, но она понадобится в следующей версии Хорошо:

CREATE TABLE dbo.UserInformation (ID INT);
SET @i += 1;

Не хорошо:

CREATE TABLE dbo.UserInformation (ID INT)
SET @i = @i + 1

Длина строки

Ограничьте длину строки максимум 79 символами. Для более длинных блоков текста с меньшими структурными ограничениями (строки документации или комментарии), длину строки следует ограничить 72 символами. Ограничение необходимой ширины окна редактора позволяет иметь несколько открытых файлов бок о бок, и хорошо работает при использовании инструментов анализа кода, которые предоставляют две версии в соседних столбцах

Хорошо:

SELECT ct.com_id, cdt.com_name, 
    ct.tax_id, pt.tax_name, tt.date  
FROM dbo.com_table AS ct 
    JOIN dbo.com_des_table AS cdt ON ct.com_id = cdt.id
    LEFT JOIN dbo.payments_table AS pt ON pt.id = ct.tax_id 
    LEFT JOIN dbo.tax_table AS tt ON ct.tax_id = tt.tax_id
WHERE ct.tax_id LIKE '001%' 
    AND ct.com_id = '1';

Не хорошо:

SELECT ct.com_id, cdt.com_name, ct.tax_id, pt.tax_name, tt.date  FROM com_table AS ct JOIN com_des_table AS cdt ON cdt.id = ct.com_id LEFT OUTER JOIN  payments_table AS pt ON pt.id =  ct.tax_id LEFT OUTER JOIN tax_table AS tt ON tt.tax_id = ct.tax_id WHERE ct.tax_id LIKE '001%' and ct.com_id = '1'

Комментарии

Создавайте комментарии в хранимых процедурах, триггерах и скриптах, когда что-либо не является очевидным. В первую очередь пишите зачем нужен этот код, а не что он делает

Используйте шапку для процедур / триггеров / функций

Пример:

/*	Author: Name Surname
	Create date: 01.01.2017
	Description: Процедура собирает статистику 
        по всем грузоотправлениям за указанный период
	Example: EXEC dbo.Procedure @from_date, @to_date
*/

Не используйте * в запросах. Указывайте названия столбцов явно

Разница будет и во времени выполнении запроса и в том, что будет возможность сделать меньше логических чтений за счет покрывающего индекса Хорошо:

SELECT CustomerID, Street, City
FROM dbo.Address
WHERE City = N‘Санкт-Петербург’;

Не хорошо:

SELECT * 
FROM dbo.Address
WHERE City = N‘Санкт-Петербург’;

Используйте нативные названия переменных. Избегайте аббревиатур и односимвольных имен

Это поможет понять код Вам и Вашим коллегам Хорошо:

DECLARE
    @item_weight INT,
    @company_name NVARCHAR(64);

Не хорошо:

DECLARE 
    @IOW INT,
    @c NVARCHAR(64);

Соблюдайте DRY (не повторяйтесь)

Принцип DRY формулируется как: «Каждая часть знания должна иметь единственное, непротиворечивое и авторитетное представление в рамках системы» Нарушения принципа DRY называют WET — «Write Everything Twice» (рус. Пиши всё по два раза) Хорошо:

DECLARE
    @item_weight INT,
    @company_name NVARCHAR(16)
;

SELECT
    @item_weight = 10,
    @company_name = N‘Microsoft’
;

Избегайте:

DECLARE @i INT
DECLARE @j INT
DECLARE @s NVARCHAR(25)

SET @i = 5
SET @j = 0
SET @s = ‘Apple’

Best practice: Используйте инструкцию SET - для констант, SELECT - для литералов

Используйте CamelStyle или under_score для именования составных пользовательских объектов

Хорошо:

CREATE TABLE dbo.MyTable (
    MyField INT
);

CREATE TABLE dbo.my_table
(
    my_field INT
);

CREATE PROC dbo.KC_MY_PROC 
    @date_from DATE,
    @date_to DATE
...

Не хорошо:

CREATE TABLE [User Information];

DECLARE strangevariableforsomething INT;

Используйте префиксы для именования объектов

Не используй префикс «sp_ » в имени своих хранимых процедур: Если имя нашей процедуры начинается с «sp_», SQL Server в первую очередь будет искать в своей главной базе данных. Дело в том, что данный префикс используется для личных внутренних хранимых процедур сервера. Поэтому его использование может привести к дополнительным расходам и даже неверному результату, если процедура с таким же имененем как у вас будет найдена в его базе.

  • P - User Stored Procedures
  • V – Views
  • FN - Scalar Valued Functions
  • TF - Table Valued Functions
  • FK - Foreign keys
  • DF - Default constraints
  • IX - Indexes
  • TR - Trigger

(Рекомендуется) Используйте имена таблиц - в единственном числе

Единственным разумным доводом для этого утверждения является тот факт, что в Английском языке, у некоторых слов, форма множественного числа описывается не явно Хорошо:

CREATE TABLE dbo.Address;

  Избегайте:

CREATE TABLE dbo.Addresses;

Вставка во временные таблицы

При вставке во временную таблицу без использования дополнительных архитектурных настроек, используйте конструкцию SELECT * INTO #table FROM… Это поможет избежать двух лишних компиляций

Пример:

SELECT id, val
INTO #tmp_Table 
FROM (
    SELECT ..
);

Наименование foreing key - используйте сначала имя родительской таблицы

Хорошо:

fk_ParentTableName_ChildTableName

  Не хорошо:

fk_ChildTableName_ParentTableName

Используй имя схемы с именем объекта

Данная операция подсказывает серверу где искать объекты и вместо того чтобы беспорядочно шарится по своим закромам, он сразу будет знать куда ему нужно пойти и что взять. При большом колличестве баз, таблиц и хранимых процедур может значительно сэкономить наше время и нервы.

Хорошо:

CREATE PROC dbo.NEW_ITEM_INSERT;

  Не хорошо:

CREATE PROC LAST_ITEM_DELETE

Много / одно - строчные операторы

Правильно организуйте операторы

Хорошо, однострочный оператор:

SELECT UserName, Address 
FROM dbo.my_table;

Хорошо, многострочный оператор:

SELECT ROW_NUMBER() OVER (ORDER BY user_name) row_num,
    user_name, address
FROM dbo.Table_1 AS t1
    JOIN dbo.Table_2 AS t2 ON t2.id = t1.id
        AND t2.Value > 100
WHERE t1.String = N'ABC'
    AND t1.user_id IN (
        SELECT user_id
        FROM dbo.Table_3
    );

Не хорошо (лишний перевод строки):

SELECT 
    UserName 
FROM 
    my_table_1
WHERE 
    MyField > 1; 

  Не хорошо (условие and должно стоять в начале условия):

SELECT user_name, address
FROM my_table_1
WHERE id > 1 AND
    value < 3;

  Избегайте смешивания подходов (отсутствует перевод строки перед FROM):

SELECT user_name, address FROM my_table 
WHERE value > 1;

Сложные условия

При определении сложных условий, описывайте каждое условие на новой строке. При этом каждая строка должна начинаться с оператора AND | OR. Исключением может быть случай, когда два или более условия накладываются на один и тот же столбец - в этом случае их можно разместить на одной строке.Делайте отступы, соответствующие уровню вложенности условий. Обозначайте скобками группы условий только там, где это необходимо - объединяя группы из условий ИЛИ условием И.

Хорошо:

SELECT user_name, last_order_date
FROM dbo.Table
WHERE first_order_date > '20170101'
    AND last_order_date < '20170414'
    AND deleted = 0
;

Не хорошо:

SELECT 
    U.Name, U.LastOrderDate
FROM dbo.Table AS T
WHERE U.LastOrderDate > '2001-01-01' AND
    U.LastOrderDate < '2001-01-31' AND U.deleted = 0
;

  Не хорошо:

SELECT 
    U.Name, U.LastOrderDate
FROM dbo.Table AS T
WHERE (U.LastOrderDate > '2001-01-01') AND (U.LastOrderDate < '2001-01-31'); -- лишние скобки

Отступы, область видимости

При создании области видимости всегда делайте отступ. (Рекомендация от себя: при сложных конструкциях, оставляйте комментарии в конце большой конструкции) Хорошо:

WHILE 1 = 1 BEGIN
    (...)
    ;
END -- WHILE 1 = 1
;

Хорошо:

WHILE 1 = 1 
BEGIN
    (...)
    ;
END
;

Не хорошо:

WHILE 1 = 1 
    BEGIN (...) END

Не хорошо:

WHILE 1 = 1 BEGIN (...) END

Отступы внутри многострочных запросов

Перечесление полей в секции SELECT должно быть оформлено единичным оступом по отношению к оператору SELECT. Слова FROM, WHERE, HAVING, GROUP BY, ORDER BY должны находиться на одном уровне с SELECT. При переносе оператора JOIN, каждый такой оператор должен иметь единичный >дополнительный отступ по отношению к FROM. При соединении таблиц по нескольким полям, оператор AND должен иметь единичный дополнительный отступ по отношению к LEFT JOIN / JOIN / CROSS APPLY и так далее.

Хорошо:

SELECT ROW_NUMBER() OVER (ORDER BY c.id) RowNum
    , c.Name, SUM(o.Amount) AS Amount
FROM dbo.Customers AS c
    JOIN dbo.Orders AS o ON c.id = o.id 
        AND o.date = c.date
WHERE c.Region = 'USA'
    AND c.Gender = 'Female' 
GROUP BY c.Name
HAVING SUM(o.Amount) > 100
ORDER BY o.Amount DESC
    , c.Name ASC
;

Скобки

В случае, когда вы используете скобки вокруг многострочных выражений, пользуйтесь одним из ниже приведенных способов

Хорошо (подобная конструкция так же используется в с#):

RETURN
(
    (...)
);

Хорошо (личная рекомендация. Избавляет от лишнего перевода строки):

RETURN (
    (...)
);

  Не хорошо:

RETURN (
(...) )

Область видимости и условные операторы

При использовании оператора IF всегда определяйте область видимости (Рекомендация оставляйте комментарии в конце больших конструкций) Хорошо:

IF 1 > 2
BEGIN
    (...)
    ;
END
;

ELSE BEGIN
    (...)
    ;
END -- IF 1 > 2
;

Хорошо:

IF 1 > 2 BEGIN
    (...)
    ;
END
ELSE BEGIN
    (...)
    ;
END
;

  Не хорошо:

IF 1 > 2
    (...)
ELSE
    (...)

Область видимости внутри процедур

Всегда определяйте область видимости при создании процедур и функций содержащих более одного оператора

Хорошо:

ALTER PROC dbo.MY_PROCEDURE @param INT
AS
BEGIN
SET NOCOUNT ON
;
    (...)
    ;

SET NOCOUNT OFF
;
END
GO

Не хорошо:

CREATE PROCEDURE dbo.uspMyProcedure @param INT
AS
    (...)

Пробелы вокруг операторов

Всегда окружайте пробелами операторы в выражениях (равно, не равно, плюс, минус, меньше, больше, умножение, деление и др)

Хорошо:

SET @i += 1
;

Хорошо:

SELECT @start_date = MIN(start_date) 
FROM dbo.Table
WHERE deleted = 0
;

Не хорошо:

SET @i=1;

Не хорошо:

SELECT @start_date=min(start_date) 
FROM dbo.Table 
WHERE deleted=0 AND StartDate>'2010-01-01';

IN vs EXISTS

Оператор IN используется когда справа строк меньше чем слева Оператор EXISTS используется когда справа строк больше

Алиасы и джойны

При выполнении джойнов всегда идентифицируйте все столбцы при помощи алиасов

Хорошо:

SELECT u.Surname, a.Street
FROM dbo.Customer AS u
    JOIN dbo.Address AS a ON u.address_id = a.address_id;

  Не хорошо:

SELECT U.Surname, Street
FROM dbo.Users U
JOIN dbo.Address ON U.AddressID = dbo.Address.AddressID

Для джойнов используйте стиль ANSI

Избегайте джойнов, используя секцию WHERE. Вместо этого используйте стиль ANSI. Ключ, на который ссылается JOIN должен стоять в конце.

Хорошо:

SELECT u.Surname, a.Street
FROM dbo.Customer AS u
    JOIN dbo.Address AS a ON a.address_id = u.address_id
        AND a.field_1 = u.field_1;

  Не хорошо:

SELECT u.surname, a.street
FROM Customer AS u, address AS a
WHERE U.AddressID = A.AddressID

Хинты

Используя хинты, разделяйте их запятыми.

Не используйте скалярные функции в запросах

Использование скалярных функций в запросах считается дурным тоном и этого стоит избегать по возможности (исключение – генерация композитного идентификатора функцией dbo.fn_getIdEx)

Хорошо:

SELECT Name,
    CAST(id / 281474976710656 AS SMALLINT) AS node_id
FROM dbo.Table;

  Не хорошо:

SELECT name,
    dbo.fn_GetNodeIdFROMCompositeId(id) AS node_id	 
FROM Table;

Проверка на наличие объекта

Дело в том что если каждый раз делать DROP и CREATE, то удаляются права на объект, а еще объект может быть в репликации и при пересоздании, из неё он удалится тоже.

Хорошо:

IF OBJECT_ID('dbo.Function', 'IF') IS NULL
    EXEC('CREATE FUNCTION dbo.Function() RETURNS @t TABLE(i INT) BEGIN RETURN END');
GO
ALTER FUNCTION() ..

Хорошо:

IF OBJECT_ID('dbo.Procedure', 'P') IS NULL
    EXEC('CREATE PROC dbo.Procedure AS');
GO
ALTER PROC dbo.Procedure ..

Не хорошо:

IF EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'dbo.MY_PROCEDURE')
    AND type in (N'FN', N'IF', N'TF', N'FS', N'FT'))
DROP FUNCTION dbo.MY_PROCEDURE
GO

Статья на хабре по теме

Включайте в свои процедуры строку SET NOCOUNT ON;

С каждым DML выражением, SQL server заботливо возвращает нам сообщение содержащее колличество обработанных записей. Данная информация может быть нам полезна во время отладки кода, но после будет совершенно бесполезной. Прописывая SET NOCOUNT ON, мы отключаем эту функцию. Для хранимых процедур содержащих несколько выражений или\и циклы данное действие может дать значительный прирост производительности, потому как колличество трафика будет значительно снижено.

Хорошо:

CREATE PROC dbo.Procedure @i INT
AS 
BEGIN
SET NOCOUNT ON;
    
    SELECT Field
    FROM dbo.Table
    WHERE id = @i;

SET NOCOUNT OFF;
END
GO

Используйте TRY – CATCH для отлова ошибок

Хорошо:

BEGIN TRY
    BEGIN TRAN tran_upd
        UPDATE dbo.Table
        SET Val = N'Y'
        ;
END TRY

BEGIN CATCH
    ROLLBACK TRAN tran_upd
    ;
END CATCH;

Спасибо за внимание

sqlcom

VK

GitHub