ustimenko (ustimenko) wrote,
ustimenko
ustimenko

Стандарт создания скриптов базы данных

Данный стандарт предназначен для разработчиков базы данных и содержит в себе описание процесса именования и требования к комментариям внутри скрипта на изменение базы данных.

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

USE xxxx_DEVELOPMENT
-- USE xxxx_RELEASE
go

При создании/изменении объекта необходимо в скрипте указывать:

  • автора
  • дату в формате dd.mm.YYYY
  • при создании — что делает объект, а при изменении — что изменено в объекте

При описании необходимо использовать русские имена объектов, а не английские, как они именуются в базе.

Объекты базы данных делятся на два класса:

  • те, которые напрямую изменяют базу, либо данные в ней;
  • те, которые реализуют слой данных объекта.

Для хранимых процедур необходимо предоставлять пример(-ы) запуска с "живыми" параметрами.

Каждый объект должен быть отправлен в отдельном sql-скрипте на e-mail Администратора базы данных. В одном письме может быть передан пакет sql-скриптов.

Для объектов, которые хранят данные и для запросов, которые перекидывают данные, формат имени файла:

YYYYMMDD.(Data|Modify|Add|Drop).Schema.Object.sql

Где:

  • Data - закачка/синхронизация данных
  • Modify - изменение структуры объекта
  • Add - добавление объекта
  • Drop - удаление объекта

Например, 20070704.Modify.hr.StaffArrangement.sql.

Для объектов, которые работают с данными, формат имени файла:

[Schema].[ТActionObject]

Где:

  • Schema - схема в базе данных,
  • T - тип объекта, например, P - procedure, F - function
  • Action - действие, которое объект делает - Get, Update и т.д.
  • Object - объект, для которого создана ХП.

Например, [HumanResources].[PGetPersonEmploymentList].

Каждый параметр в процедуре должен быть задокументирован.

Tags: Базы данных
Subscribe
  • Post a new comment

    Error

    default userpic

    Your IP address will be recorded 

    When you submit the form an invisible reCAPTCHA check will be performed.
    You must follow the Privacy Policy and Google Terms of use.
  • 0 comments