Многие системы баз данных не допускают комментариев или описаний таблиц и полей, поэтому как вы собираетесь документировать цель таблицы/поля, кроме очевидного наличия хороших соглашений об именах?
(Предположим теперь, что "отличные" имена таблиц и полей недостаточно для документирования полного значения каждой таблицы, поля и отношений в базе данных.)
Я знаю, что многие люди используют диаграммы UML для визуализации базы данных, но я редко встречаюсь, если когда-либо видел диаграмму UML, включая комментарии к полям. Тем не менее, у меня есть хороший опыт использования комментариев внутри файлов .sql
. Недостатком этого подхода является то, что он требует, чтобы файлы .sql
обновлялись вручную по мере изменения структуры базы данных с течением времени, но если вы это сделаете, вы также можете получить ее под управлением версии.
Некоторые другие методы, которые я видел, представляют собой отдельный документ, описывающий структуру и отношения базы данных и поддерживаемые вручную комментарии внутри кода ORM или другого кода сопоставления базы данных.
Как вы решили эту проблему в прошлом? Какие существуют методы и каковы различные плюсы и минусы, связанные с ними? Как вы хотели бы, чтобы это было разрешено в "идеальном мире"?
Обновление
Как отмечали другие, большинство популярных движков SQL действительно позволяют комментировать, что здорово. Как ни странно, люди, похоже, не слишком много используют эти функции. По крайней мере, не по проектам, с которыми я занимался в прошлом.