COMMENT
COMMENT
Определение комментария для объекта базы данных.
Синтаксис
COMMENT ON
[
[ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ] объект
COLUMN таблица.поле|
FUNCTION функция ( аргумент [. ...] ) |
AGGREGATE агрвгатная_функция агрегатный_тип |
OPERATOR оператор ( левый_тип , правый_тип ) |
TRIGGER триггер ON таблица
] IS 'текст'
Параметры
- DATABASE INDEX | RULE | SEQUENCE | TABLE | TYPE VIEW. Тип объекта базы данных, для которого создается комментарий.
- объект. Имя объекта заданного типа, для которого создается комментарий.
- COLUMN таблица.поле. Уточненное имя поля, для которого создается комментарий.
- FUNCTION функция ( аргумент [, ...] ). Имя функции, для которой создается комментарий, с указанием типов данных аргументов.
- AGGREGATE агрегатная_функция агрегатный_тип. Имя агрегатной функции (и агрегатный тип данных), для которой создается комментарий.
- OPERATOR оператор ( левый_тип, правый_тип). Имя оператора, для которого создается комментарий, с указанием типов левого и правого операндов, разделенных запятыми и заключенных в круглые скобки. Если какой-либо из типов отсутствует, он заменяется ключевым словом NONE.
- TRIGGER триггер ON таблица. Имя триггера, для которого создается комментарий, и имя таблицы, к которой относится триггер.
- текст. Текст комментария.
Результаты
COMMENT. Это сообщение выдается при успешном создании комментария для объекта.
Описание
Команда COMMENT относится к числу специфических команд PostgreSQL. Она предназначена для комментирования различных объектов и самой базы данных. В клиенте psql комментарии выводятся следующими командами:
- \д+ — вывод списка всех доступных баз данных с комментариями;
- \dd — вывод списка объектов всех баз данных с комментариями;
- \d+ — вывод списка объектов текущей базы данных с комментариями;
- \dt+ — вывод списка всех таблиц в текущей базе данных с комментариями;
- \ds+ — вывод списка всех последовательностей в текущей базе данных с комментариями;
- \dv+ — вывод списка всех представлений в текущей базе данных с комментариями;
- \df+ — вывод списка всех функций в текущей базе данных с комментариями;
- \da+ — вывод списка всех агрегатных функций в текущей базе данных с комментариями;
- \do+ — вывод списка всех операторов в текущей базе данных с комментариями;
- \dT+ — вывод списка всех типов в текущей базе данных с комментариями. Чтобы удалить комментарий, укажите вместо текста NULL.
Примечание 1
Примечание 1
При удалении объектов из системы удаляются и связанные с ними комментарии.
