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

Откуда:
Сообщений: 2
В рамках изучения ASP.NET MVC, JQuery и прочих веб дел я написал IIS Web App LiveDoco для разработчиков БД (ну и DBA в меньшей степени) которая позволяет:

  • Комфортно (по крайней мере на мой взгляд) просматривать структуру БД MS SQL Server
  • Искать по подстроке в названиях обьектов БД (таблицы, колонки, функции итд) и описаниях которые хранятся в Extended Properties( далее везде EP) с именем "MS_Description" (так принято у MS), а так же в EP с любыми другими именами.
  • Редактировать эти описания и добавлять новые с произвольными именами.
    так же экспортировать в SQL скрипт чтобы можно было загрузить в БД с аналогичной структурой.
  • Выгружать структуру БД в XML или произвольный текст если не лень самим писать шаблон выгрузки (типа плагин).
  • Экспорт EP в виде SQL скрипта для последующего импорта в БД аналогичной структуры. Скрипт успешно отрабатывает как добавление новых EP в БД так и запись поверх существующих (add/update extended property)

    Другие фичи:
  • Foreign Keys показываются как ссылки по которым можно переходить.
  • LiveDoco поддерживает глубокие ссылки (deep linking) поэтому можно посылать ссылки коллегам в е-майлах или через ICQ/Skype и т.д. Естессвенно коллеги должны иметь доступ к IIS где установлена LiveDoco

    LiveDoco уникальна тем что она не генерит всю документацию сразу как это делают другие аналогичные программы, а просто рендерит(кстати весьма резво) странички прямо из INFORMATION_SCHEMA и прочих системных вьюшек и таблиц. В том числе и комменты которые как я уже говорил хранятся в виде стандартных Extended Properties и поэтому LiveDoco совместима с любыми другими программами геренящими документацию, такими как Red Gate SQL Doc, Apex SQL Doc, Elsasoft SQLSpec итд.

    Основная цель LiveDoco - легкая и удобная навигация и поиск по метаданным БД а так же легкое редактирование описаний (и поиск в них же). Там внизу есть списки зависимых и зависящих обьектов, а так же в каждой колонке входящей в PK на которой имеются FK в других таблицах будет полный список этих самых ссылающихся колонок в виде гиперссылок. При клике на нее (а так же на любую ссылку на подобьект - колонку таблицы или view, параметр процедуры, триггер итд) LiveDoco не просто переходит на нужную страницу, но и проматывает страницу к этому самому подобьекту и подсвечивает его на секунду чтобы привлечь внимание и сэкономить секунды на поиск глазами. Таким образом можно быстренько перейти по FK ссылке, поглядеть что там и тут же вернуться назад кнопкой Back. В малознакомых БД очень помогает.

    Тут более детальное описание (на английском): A new approach to documenting databases
    Тут дема: LiveDoco Online Demo
    Есть 30 дневная пробная версия.

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

    Если кому то нравится но нет денег чтобы купить - там есть бесплатный вариант для блоггеров кому не лень писать статью про LiveDoco :)
  • 6 май 12, 22:21    [12518203]     Ответить | Цитировать Сообщить модератору
     Re: документирование БД при помощи web приложения - зацените  [new]
    Jovanny
    Member

    Откуда:
    Сообщений: 1196
    Как по мне, PowerDesigner, кроме того, что является превосходным средством для проектирования баз данных с возможностью синхронизации, ещё и генерирует документацию в нескольких форматах, в том числе и html.
    Тут:
    1) кроме документации, нет никаких других возможностей.
    2) не поддерживаются пользовательский типы, сборки, триггеры базы данных, может, что-то ещё (или я не внимательно смотрел).

    Преимущества:
    1) всегда удалённо можно посмотреть информацию по базе.
    7 май 12, 10:39    [12519269]     Ответить | Цитировать Сообщить модератору
     Re: документирование БД при помощи web приложения - зацените  [new]
    Zarium
    Member

    Откуда:
    Сообщений: 2
    Да, Вы правы, LiveDoco в основном предназначена для документирования существующих БД, особенно при коллективной работе.
    Триггеры показываются: Например тут

    Пока что я добавил только самые основные обьекты которые обычно нуждаются в документировании в первую очередь, но будущем возможно добавлю и Assemblies и Custom Data и Types Partition Functions и тд.

    На мой взгляд основные преимущества LiveDoco перед другими средствами для документирования БД это:
  • Возможность подключаться к любой БД SQL Server - не нужно предварительно генерировать документацию.
  • Можно редактировать комментарии "не отходя от кассы" прямо на самой страничке документации.
  • Можно просто скопировать ссылку на страничку определенной таблицы или процедуры и послать коллеге в ICQ - с CHM или Word документом это невозможно, а с HTML не всегда возможно, потому что часто используются IFRAME как самый легкий способ реализовать дерево навигации.
  • Можно искать подстроку в конкретных обьектах - например только в именах столбцов VIEWs - может быть полезным если БД большая а искомая строка слишком "шумная" - т.е. слишком много нерелевантных результатов.

    Так же есть экспорт в XML или произвольный текст - таким образом можно автоматизировать определенные виды генерации скриптов, или использовать XML для экспорта метаданных.
  • 7 май 12, 11:49    [12519414]     Ответить | Цитировать Сообщить модератору
    Все форумы / Microsoft SQL Server Ответить