Как Вы документируете свою структуру базы данных? [закрытый]
Вы можете использовать этот метод, который позволяет центрировать JFrame и полноэкранный режим одновременно.
yourframe.setExtendedState(JFrame.MAXIMIZED_BOTH);
10 ответов
MySQL позволяет комментарии к таблицам и строкам. PostgreSQL делает также. Из других ответов Oracle и MSSQL имеют комментарии также.
Для меня, комбинации диаграммы UML для быстрого напоминания на именах полей, типах, и ограничениях и внешнем документе (TeX, но мог быть любой формат) с расширенным описанием всего связанного с базой данных - специальных значений, полевых комментариев, примечаний доступа, безотносительно - работы лучше всего.
SQL Server имеет расширенные свойства, которые могут заботиться об этом.
Эта статья описывает, как действительно настраивают их в SQL, Разъединяют http://www.developer.com/db/article.php/3677766
, Это может использоваться в сочетании с документ RedGate SQL для создания хорошего словаря Данных.
Я использую комментарии, присоединенные к таблицам и столбцу. SchemaSpy является большим инструментом для генерации файлов документации HTML из Вашей схемы, включая комментарии.
Однажды я записал основной синтаксический анализатор SQL, который проанализирует операторы CREATE TABLE и разделит особенно отформатированные комментарии. Они были тогда выполнены последующую обработку в ЛАТЕКСНЫЙ источник и представлены к PDF. Это было вдохновлено Javadoc и использовалось для создания документации для Этот продукт . Впоследствии функция словаря данных была встроена в менеджера склада, и измененная версия ЛАТЕКСНОГО генератора использовалась для рендеринга словаря данных от менеджера склада.
На другом проекте я использовал Visio - версия, которая идет с Архитектором Visual Studio Enterprise, передаст инженеру базу данных. SQL, так сгенерированный, имел таблицу и комментарии столбца, представленные в строках комментария, которые были довольно просты для парсинга. Инструмент, который я записал сгенерированным файлам MIF, которые были быть включенными в документ спецификации, созданный с FrameMaker.
, Если у Вас есть инструмент репозитория такой как Powerdesigner, можно поддержать модели данных в нем и получить отчеты о репозитории, которые включают документацию, которую Вы ввели. При необходимости в глубокой интеграции словаря данных с функциональными спецификациями (Довольно полезный для систем хранилища данных, где ETL сложен и включает значительное вычисление полученных значений), можно все еще извлечь метаданные и записать утилиту для генерации чего-то, что интегрирует словарь данных в документ спецификации. Это также позволяет перекрестно ссылаться между объектами словаря данных и другими документами спецификации и поколением индексов, которые покрывают словарные определения данных и связанную документацию, такие как спецификация того, как что-то вычисляется с примерами.
Мы записали документ слова, который перечисляет таблицы, поля и что все делает. Это сохранено схемой, которая показывает, как все связывается/касается друг друга. Это - довольно простой документ действительно, просто загрузка таблиц с Именем поля> Тип данных> Цель
Я использую Firebird, который имеет поле описания для всех системных объектов (таблицы, столбцы, представления, процедуры и параметры, триггеры, и т.д.) Это хорошо, потому что можно легко совместно использовать его с другими (документы идут с базой данных, не отдельно), и Вы никогда не теряете его.
Большая часть администратора. инструменты для Firebird позволяют Вам редактировать эти описания и существуют некоторые специализированные инструменты (как IBDesc, например), которые создают хороший HTML, или PDF сообщает, что можно распечатать (для некоторых или всех таблиц) легко.
Это - действительно упрощенный подход, но я использую пару страниц Wiki: один с mysqldump базы данных и одним записанным в немного большем количестве подобного английскому языку формата.
Для проектов я продолжил работать, это было достаточно (через десятки уровня таблиц). Я не знаю, как хорошо это могло бы масштабироваться к большим проектам (скажите в сотнях таблиц), но это было хорошо до сих пор.
Я комментирую свои базы данных, как я комментирую свои программы. Путем записи хороший (я надеюсь), комментарии в исходном коде (файл SQL, содержащий инструкции по DDL).
Используя КОММЕНТАРИЙ SQL другая возможность. Хорошая вещь с ними состоит в том, что они всегда с Вашими объектами, сохранены с ними, и т.д. Плохая вещь состоит в том, что они более ограничены (например, в длине).
Так как мы используем Рационального Архитектора программного обеспечения, мы используем его функции открытия данных, чтобы зарегистрировать наши базы данных и затем аннотировать их оттуда.
В Oracle можно прокомментировать таблицы, и она хранит его в словаре данных.
Однако я храню всю свою таблицу, столбец, индексирую комментарии в очень старой версии ERWin. Это - основной источник истины и генерирует DDL для составления таблиц, и т.д. Оттуда, я могу извлечь его в документ слова или PDF.