Описания
функциональныйРедактируйте описания таблиц, представлений и столбцов и записывайте их на сервер в виде DDL-комментариев.
Таблицы, представления и столбцы могут иметь описание, комментарий, который сама база данных хранит рядом с объектом. SQLly считывает эти описания везде, где отображается схема (в столбце Comment каталога объектов, в экспорте документации схемы, в контексте ИИ), и вы можете писать их из двух мест без ручного написания синтаксиса комментариев движка.
Где редактировать
- Редактировать структуру - это Описание Поле для таблицы находится под списком столбцов, и каждая строка столбца имеет своё собственное поле для описания. Изменения описания отображаются в списке изменений как Установить описание. В большинстве движков они записываются в скрипт после структурных изменений; комментарий относится к столбцу, поэтому переименование или изменение типа не требует дополнительного оператора. В MySQL и MariaDB, где изменение столбца заново задаёт его полное определение, столбец, который переименован, получил новый тип или значение по умолчанию либо добавлен, несёт своё описание в том же предложении, поэтому он сохраняет (или получает) свой комментарий, и структурное изменение не отменяется.
- Свойства объекта — Общие страница таблицы или представления показывает актуальное описание в редактируемом поле, как только оно прочитано. Изменение помечает страницу как изменённую; Просмотр изменений показывает точный оператор перед выполнением чего-либо.
Очистка текста удаляет описание. Оба экрана следуют обычным правилам проверки: «Изменить структуру» отправляет скрипт на вкладку редактора, а «Свойства объекта» выполняется только со своего листа проверки.
Если текущие описания прочитать не удаётся (например, из-за прав доступа), оба экрана скрывают поле описания и показывают вместо него причину. Правка никогда не превращается в скрипт на основе догадки, потому что на SQL Server выбор нужной процедуры зависит от того, существует ли уже описание.
Что SQLly выполняет на каждом движке
| Движок | Описание таблицы / представления | Описание столбца |
|---|---|---|
| SQL Server / Azure SQL | Этот MS_Description расширенное свойство: sp_addextendedproperty когда ни одного не существует, sp_updateextendedproperty когда он есть (включая тот, который содержит пустой текст), sp_dropextendedproperty чтобы очистить. Представления рассматриваются как представления. | Те же процедуры на уровне столбца. |
| PostgreSQL | COMMENT ON TABLE / COMMENT ON VIEW … IS '…'; IS NULL очищает. | COMMENT ON COLUMN … IS '…'. |
| CockroachDB | COMMENT ON TABLE … IS '…'. В CockroachDB нет COMMENT ON VIEW, поэтому поле описания представления скрыто с указанием этой причины. | COMMENT ON COLUMN … IS '…'. |
| DuckDB | COMMENT ON TABLE / COMMENT ON VIEW; IS NULL очищает. | COMMENT ON COLUMN. |
| База данных Oracle | COMMENT ON TABLE … IS '…' (Oracle обращается к представлениям с ключевым словом TABLE); IS '' очищает. | COMMENT ON COLUMN. |
| MySQL / MariaDB | ALTER TABLE … COMMENT = '…'. Представления не могут хранить описание (сервер сообщает комментарий каждого представления как VIEW), поэтому поле представления скрыто по этой причине. | В MySQL нет инструкции, которая изменяет только комментарий, поэтому SQLly выполняет ALTER TABLE … MODIFY COLUMN. Если меняется только описание, столбец переписывается в точности как SHOW CREATE TABLE печатает его и заменяет только COMMENT '…' , сохраняя всё остальное, включая условия после комментария, например у MariaDB CHECK (json_valid(…)); если этот текст не удаётся прочитать, SQLly отказывается вносить изменения, а не угадывает. Когда та же правка заодно переименовывает столбец, меняет его тип или значение по умолчанию либо добавляет его, то COMMENT попадает в ту CHANGE/MODIFY/ADD вместо этого. |
| ClickHouse | ALTER TABLE … MODIFY COMMENT '…'. Представления нельзя комментировать после создания; SQLly сообщает вам, что нужно воссоздать представление с COMMENT выражение. | ALTER TABLE … COMMENT COLUMN … '…'. |
| SQLite / libSQL | Нет серверного хранилища комментариев. Поля описания скрыты, и редактор показывает причину вместо них. | |
Текст заключается в кавычки для движка: встроенные кавычки везде удваиваются, значения SQL Server отправляются как Unicode N'…' литералы, а MySQL и ClickHouse также экранируют обратную косую черту.
В MySQL и MariaDB столбец, который «Редактировать структуру» переименовывает, меняет тип или значение по умолчанию, пересоздаётся по полям редактора: его тип, допустимость NULL, значение по умолчанию, автоинкремент, его ON UPDATE (для столбцов timestamp и datetime) и его описание. Переопределение набора символов или сопоставления, сгенерированное выражение, INVISIBLEили на уровне столбца CHECK не переносится заново; если такое есть в текущем определении, скрипт сообщит об этом в -- WARNING строке, чтобы вы могли добавить это к типу перед выполнением.

