COMMENTS

CHARACTER SETОператоры обработки данных (DML)

Объекты базы данных и сама база данных могут содержать примечания.Это удобное средство документирования во время разработки базы данных и её поддержки.

`COMMENT ON`

Назначение

Документирование метаданных.

Доступно в

DSQL, ESQL

Синтаксис

COMMENT ON <object> IS {'sometext' | NULL}
<object> ::=
    { DATABASE | SCHEMA }
  | <basic-type> objectname
  | USER username [USING PLUGIN plugin_name]
  | COLUMN relationname.fieldname
  | [PROCEDURE | FUNCTION] PARAMETER
    [package_name.] routinename.paramname
  | {PROCEDURE | [EXTERNAL] FUNCTION}
    routinename
  | [GLOBAL] MAPPING mappingname

<basic-type> ::=
    CHARACTER SET
  | COLLATION
  | DOMAIN
  | EXCEPTION
  | FILTER
  | GENERATOR
  | INDEX
  | PACKAGE
  | ROLE
  | SEQUENCE
  | TABLE
  | TRIGGER
  | VIEW

Table 1. Параметры оператора `COMMENT ON`
Параметр	Описание
sometext	Текст комментария.
basic-type	Тип объекта метаданных.
objectname	Имя объекта метаданных.
relationname	Имя таблицы или представления.
filedname	Имя поля таблицы или представления.
routinename	Имя хранимой процедуры или функции.
paramname	Имя параметра хранимой процедуры или функции.
package_name	Имя пакета.
username	Имя пользователя.
plugin_name	Имя плагина управления пользователями.
mappingname	Имя отображения.

Оператор COMMENT ON добавляет комментарии для объектов базы данных (метаданных). Комментарии при этом сохраняются в текстовые поля RDB$DESCRIPTION типа BLOB соответствующей системной таблицы (из этих полей клиентское приложение может просмотреть комментарии).

При добавлении комментария для пользователя вы можете уточнить в каком плагине управления пользователями он находится с помощью необязательного предложения USING PLUGIN.Если это предложение отсутствует, то предполагает что пользователь создан в плагине управления по умолчанию, то есть первого плагина указанного в параметре UserManager в файле firebird.conf или databases.conf.

Note	Если вы вводите пустой комментарий (''), то он будет сохранен в базе данных как `NULL`.