MySQL / MariaDB добавить колонку документации

Question

Могу ли я добавить документацию в таблицу, которую я могу запросить из базы данных? Было бы здорово понять свойства, когда вы вернетесь к столу через долгое время.

Answer 1

Используйте параметр COMMENT для столбцов, таблиц и некоторых других конструкций. Пример:

mysql> create table with_comments (x int comment "column comment" 
        ) comment "table comment";
Query OK, 0 rows affected (0.02 sec)

mysql> show create table with_comments\G
*************************** 1. row ***************************
       Table: with_comments
Create Table: CREATE TABLE `with_comments` (
  `x` int(11) DEFAULT NULL COMMENT 'column comment'
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci COMMENT='table comment'
1 row in set (0.00 sec)

Предостережение: длина таких комментариев довольно ограничена.

Если вы хотите предоставить параграфы документации, вам понадобится какой-то специальный механизм, например, db сстол с колонкой TEXT для вещей.

Answer 2

MySQL и MariaDB имеют функцию SHOW CREATE TABLE, но она просто покажет базовый DDL, который будет генерировать таблицу, которая существует в вашей базе данных. Он не будет отображать комментарии, которые могли присутствовать в фактическом операторе CREATE, который вы выполняли при создании таблицы. Одним из возможных решений здесь было бы просто сохранить ваши CREATE сценарии в базе кода приложения, включая любые комментарии, которые вы хотите. Вы можете создавать версии сценариев, используя такой инструмент, как Liquibase. Затем, когда вы хотите увидеть комментарии, просто просмотрите сценарии.