COMMENT
Crea o cambia un comentario acerca de un objeto de la base de datos.
Sintaxis
COMMENT ON { TABLE object_name | COLUMN object_name.column_name | CONSTRAINT constraint_name ON table_name | DATABASE object_name | VIEW object_name } IS 'text' | NULL
Parámetros
- object_name
-
Nombre del objeto de la base de datos en el que se realiza un comentario. Puede agregar un comentario en los siguientes objetos:
-
TABLE
-
COLUMN (también lleva un valor column_name [nombre_de_columna]).
-
CONSTRAINT (también lleva un valor constraint_name [nombre_de_restricción] y un valor table_name [nombre_de_tabla]).
-
DATABASE
-
VIEW
-
SCHEMA
-
- IS "texto"|NULL
-
El texto del comentario que desea agregar o sustituir para el objeto especificado. La cadena texto es el tipo de datos TEXT. Incluya el comentario entre comillas simples. Establezca el valor en NULL para eliminar el texto del comentario.
- column_name
-
Nombre de la columna en la que se realiza un comentario. Parámetro de COLUMN. Sigue una tabla especificada en
object_name
. - constraint_name
-
Nombre de la restricción en la que se realiza un comentario. Parámetro de CONSTRAINT.
- table_name
-
Nombre de una tabla que contiene la restricción. Parámetro de CONSTRAINT.
Notas de uso
Para agregar o actualizar un comentario, debe ser un superusuario o el propietario de un objeto de base de datos.
Los comentarios en bases de datos solo pueden aplicarse a la base de datos actual. Se muestra un mensaje de advertencia si intenta comentar en una base de datos diferente. Aparece el mismo mensaje de advertencia sobre comentarios de bases de datos que no existen.
No se admiten comentarios en tablas externas, columnas externas ni columnas de vistas de enlace de tiempo de ejecución.
Ejemplos
En el ejemplo siguiente se agrega un comentario a la tabla SALES.
COMMENT ON TABLE sales IS 'This table stores tickets sales data';
En el siguiente ejemplo, se muestra el comentario de la tabla SALES.
select obj_description('public.sales'::regclass);
obj_description
-------------------------------------
This table stores tickets sales data
En el siguiente ejemplo, se elimina un comentario de la tabla SALES.
COMMENT ON TABLE sales IS NULL;
En el siguiente ejemplo, se agrega un comentario a la columna EVENTID de la tabla SALES.
COMMENT ON COLUMN sales.eventid IS 'Foreign-key reference to the EVENT table.';
En el siguiente ejemplo, se muestra un comentario en la columna EVENTID (columna número 5) de la tabla SALES.
select col_description( 'public.sales'::regclass, 5::integer );
col_description
-----------------------------------------
Foreign-key reference to the EVENT table.
En el siguiente ejemplo, se agrega un comentario descriptivo a la tabla EVENT.
comment on table event is 'Contains listings of individual events.';
Consulte el catálogo del sistema PG_DESCRIPTION para ver una lista de comentarios. El siguiente ejemplo devuelve la descripción de la tabla EVENT.
select * from pg_catalog.pg_description
where objoid =
(select oid from pg_class where relname = 'event'
and relnamespace =
(select oid from pg_catalog.pg_namespace where nspname = 'public') );
objoid | classoid | objsubid | description
-------+----------+----------+----------------------------------------
116658 | 1259 | 0 | Contains listings of individual events.