Pull to refresh

Mysql Documentor — простая утилита для документирования баз данных Mysql 5+

Reading time2 min
Views1.3K

Как мы дошли до жизни такой

Тут мы хотели вставить красивую и короткую презентацию из Slideshare, но она, кажется, не понравились НЛО =)

Что умеет

Mysql Documentor читает схему данных, комментарии к таблицам и полям, а затем при помощи несложного шаблона Smarty генерирует html-описание.

Сегодня MyDoc умеет:
  • строить список таблиц с комментариями;
  • строить список полей каждой таблицы с комментариями;
  • для каждой таблицы строить список ключей;
  • при наличии внешних ключей делать ссылки с полей на связанные таблицы;
  • работать на всех платформах, на которых работает php с расширением mysqli;
  • smarty-синтаксис шаблонов позволяет строить документацию любого дизайна и формата (в том числе не html);
  • удобно настраивается прямо в запускающем скрипте.

Что не умеет, но скоро будет

  • нет статистики по таблицам и полям;
  • никак не обрабатывается и не строится документация по триггерам и хранимым процедурам.

Что ещё в ближайших планах

  • группировка таблиц на основании тэгов из комментариев;
  • вывод схемы БД в формате Graphwiz.

Как получить

Просто скачайте его с нашего сайта (там же есть пример построенной документации).

Как это заставить работать

Вообще-то заставлять никого не придётся. Достаточно заглянуть в файл README.TXT (он сейчас по-английски) и выполнить нехитрые инструкции. Вам потребуется всего пара минут.

И, что, бесплатно?

Да. Mysql Documentor распространяется в исходных текстах на условии лицензии GPL. Кстати, на info@softuniq.com можно (и нужно!) присылать свои контрибьюты. Svn-репозиторий скоро будет.

Что дальше?

Разработка утилиты идёт полным ходом. За новостями удобно следить, подписавшись на RSS-ленту нашего уютного бложега. =)
Tags:
Hubs:
+40
Comments49

Articles

Change theme settings