Добро пожаловать в форум, Guest  >>   Войти | Регистрация | Поиск | Правила | В избранное | Подписаться
Все форумы / Microsoft SQL Server Новый топик    Ответить
 Документирование средствами MS SQL  [new]
Lucia
Member

Откуда: РФ, г. Уфа
Сообщений: 24
Добрый день!
Есть БД MS SQL 2005. Таблиц около 100, SP около 200-300.

В плане именования таблиц и ХП соблюдаются соглашения - чтобы было понятно назначение талицы, а особенно назначение ХП. Но всего ведь не предусмотришь.
Очень хотелось бы узнать, существуют ли средства документирования SP, когда можно на процедуру навесить некий набор тэгов (о том что она делает, к чему относится) и совершать поиск по ним?
(описание к таблицам и ХП, а также комментарии юзаем :) )
13 окт 09, 09:30    [7776374]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
tpg
Member

Откуда: Novosibirsk
Сообщений: 23902
Создайте свой шаблон "создания процедур" и впишите туда какие вам нужно тэги.
13 окт 09, 09:32    [7776379]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
Lucia
Member

Откуда: РФ, г. Уфа
Сообщений: 24
Что значит "шаблон создания процедур" ?
13 окт 09, 09:32    [7776382]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
aleks2
Guest
Lucia,

1. Подключись к базе через MS Access ADP
2. Просмотри на тамошний конструктор таблиц - там есть комментарии для полей и таблицы в целом.
3. То же самое есть и в EM или SQL Man.Stud..
13 окт 09, 09:38    [7776394]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
komrad
Member

Откуда: Msk -> Utrecht
Сообщений: 5189
Lucia
Добрый день!
Есть БД MS SQL 2005. Таблиц около 100, SP около 200-300.

В плане именования таблиц и ХП соблюдаются соглашения - чтобы было понятно назначение талицы, а особенно назначение ХП. Но всего ведь не предусмотришь.
Очень хотелось бы узнать, существуют ли средства документирования SP, когда можно на процедуру навесить некий набор тэгов (о том что она делает, к чему относится) и совершать поиск по ним?
(описание к таблицам и ХП, а также комментарии юзаем :) )


смотрите в сторону extended properties и процедур

/*To add an extended property*/
sp_addextendedproperty 


/*To update an extended property*/
sp_updateextendedproperty 


/*To delete an extended property*/
sp_dropextendedproperty 


/*To view an extended property*/
fn_listextendedproperty
sys.extended_properties 
13 окт 09, 09:40    [7776401]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
tpg
Member

Откуда: Novosibirsk
Сообщений: 23902
Lucia
Что значит "шаблон создания процедур" ?
В SSMS открываете меню View, а в нем Template Explorer. В нем давите правой кнопкой мыши по папке Stored Procedures, например, и выбираете New->Template.
Дальше, думаю, понятно...
13 окт 09, 09:43    [7776414]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
IamZet
Member

Откуда:
Сообщений: 37
Хотелось бы развернуть вопрос в другую сторону - знает ли кто средства создания документации процедур и функций по стандартным комментариям или extended properties? Что нибудь типа SandCastle, чтобы можно было в в каждой процедуре использовать комментарии со стандартными тэгами (<author>, <description>, <param> и т.д.), а ны выходе получить документацию в CHM. С год назад пытался что-то такое найти - не вышло. Большая часть средств документирования генерят малополезные описания, основанные на DDL объектов - название, параметры с типами.
13 окт 09, 11:09    [7777079]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
afgm
Member

Откуда:
Сообщений: 586
to Lucia,

Я тоже ничего не нашёл в своё время. Случилось мне пару лет назад перейти в другую компанию, и в среде перейти с Firebird на MS SQL. Проект был в таком состоянии, что ответить на вопрос: "что, где и для чего?" не перелопатив тонну исходников и не грузанув свой мозг, было нельзя.
К тому моменту использовался MS SQL 2000. У него есть известная проблема - это потеря зависимостей, при перекомпиляции зависимых объектов. Мало того что в самой БД теряются связи, так ещё и непонятно где в проекте используется вся эта "математика". Тогда я стал перебирать все утилиты работы с данной БД и вообще всё вообразимое для построения какой либо документации. Ничего сносного не находилось. Помимо чистого анализа системы и изучения для дальнейшего понимания и развития, была необходимость "причесать" проект. Именование процедур и прочих объектов было подчинено некой логике... логике каждого разработчика, из-за чего и возникало ощущение, что систему писали по 3-м разным руководствам. Окончательно отчаявшись я стал писать свой документатор. Для разработки была взята связка PHP+Firebird, т.к. эта СУБД была мне хорошо знакома на тот момент, а WEB-интерфес для документатора очень удобен. Началась его история в марте 2008-го. На данный момент он обладает многопроектностью, т.е. может вести несколько проектов. Сам проект состоит из БД и файлов. БД грузится напрямую. Файлы грузятся с диска, предварительно выгружаясь из SVN. После загрузки включается парсинг исходников процедур, функций, представлений и комментариев таблиц. Парсинг выдерает описания, автора, дату, группу,TODO в коде, дополнительные атрибуты и т.д. - вся эта информация может быть использована для дальнейшего анализа. Так же строятся зависимости как внутри БД, родные зависимости из MS SQL не используются по описанным выше причинам, и зависимости между файлами и БД, т.е. все со всеми. Так можно понять мёртвые объекты или глутья по этому дереву во все стороны. Соответственно в системе есть поиск как по имени, так и по содержимому. Есть функция построения графа зависимостей, но она не очень практична, и носит больше исследовательский характер. Последнее нововведение в документатор - это помощник в рефакторинге. т.е. он ищет все вхождения искомого выражения, и предлагает пользователю согласиться с изменениями или отклонить их. После того как неопределённых замен не осталось документатор генерит скрипт (выполняется руками, так спокойнее :) ) и патчит файлы. После "патчинга" с 2-х сторон (файлы и БД) система тестируется. Если всё хорошо, то изменения коммитятся в SVN.

Есть идея выложить всю эту кутерьму в общий доступ, но никак руки не доходят. Если есть большая надобность группе людей - пересмотрю идею с выкладыванием ещё раз :)
13 окт 09, 13:54    [7778565]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
nrg_fly
Member

Откуда:
Сообщений: 138
Lucia
Добрый день!
Есть БД MS SQL 2005. Таблиц около 100, SP около 200-300.

В плане именования таблиц и ХП соблюдаются соглашения - чтобы было понятно назначение талицы, а особенно назначение ХП. Но всего ведь не предусмотришь.
Очень хотелось бы узнать, существуют ли средства документирования SP, когда можно на процедуру навесить некий набор тэгов (о том что она делает, к чему относится) и совершать поиск по ним?
(описание к таблицам и ХП, а также комментарии юзаем :) )


есть классный тул (http://www.elsasoft.org/), не бесплатный, но все равно дает возможность создавать полноценный документ (chm, html) с древовидной структурой и диаграммамы связей.
В незарегистрированной версии, он создает документ и на каждую страницу добавляет текст о том, что версия продукта не зарегистрирована; я создав html документ с великим множеством страниц, потом отрываю его в студии и удаляю все ненужные коменты, и у меня готовый в очень функциональный документ, проверено !
14 окт 09, 10:52    [7782959]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
aleks2
Guest
www.elsasoft.org

вопчем-то бесполезная игрушка. Имитировать деятельность она, возможно, помогает, но вот называть продукт ее труда "документацией" - это, блин, профанация.
14 окт 09, 11:08    [7783106]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
Дедушка
Member

Откуда: Город трёх революций
Сообщений: 5111
aleks2
www.elsasoft.org

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

аргументируйте пожалуйста.
14 окт 09, 11:10    [7783123]     Ответить | Цитировать Сообщить модератору
 Re: Документирование средствами MS SQL  [new]
aleks2
Guest
Дедушка
aleks2
www.elsasoft.org

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

аргументируйте пожалуйста.


Дык откель она возмет сведения о СМЫСЛЕ и ПРЕДНАЗНАЧЕНИИ тех или иных объектов БД?

А перечень объектов базы я и друними тулузами осмотреть могу.
14 окт 09, 13:32    [7784433]     Ответить | Цитировать Сообщить модератору
Все форумы / Microsoft SQL Server Ответить