COMMENT - Amazon Redshift
SintaxeParâmetrosObservações de usoExemplos

COMMENT

Cria ou altera um comentário sobre um objeto do banco de dados.

Sintaxe

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

nome_objeto

Nome do objeto do banco de dados que está sendo comentado. Você pode adicionar um comentário aos seguintes objetos:

  • TABLE

  • COLUMN (também utiliza um nome_coluna).

  • CONSTRAINT (também utiliza um nome_restrição e um nome_tabela).

  • DATABASE

  • VIEW

  • SCHEMA

IS 'text' | NULL

O texto do comentário que você deseja adicionar ou substituir pelo objeto especificado. A string text é o tipo de dados TEXT. Coloque o comentário entre aspas simples. Defina o valor como NULL para remover o texto do comentário.

column_name

Nome da coluna que está sendo comentada. Parâmetro de COLUMN. Acompanha uma tabela específica em object_name.

nome_restrição

Nome da restrição que está sendo comentada. Parâmetro de CONSTRAINT.

table_name

Nome de uma tabela que contém a restrição. Parâmetro de CONSTRAINT.

Observações de uso

É necessário ser um superusuário ou o proprietário de um objeto de banco de dados para adicionar ou atualizar um comentário.

Comentários sobre bancos de dados podem ser aplicados somente ao banco de dados atual. Uma mensagem de advertência é exibida se você tentar fazer comentários sobre um banco de dados diferente. A mesma mensagem é exibida para comentários sobre bancos de dados que não existem.

Comentários em tabelas externas, colunas externas e colunas de visões de vinculação tardia não são compatíveis.

Exemplos

O exemplo a seguir adiciona um comentário à tabela SALES. 

COMMENT ON TABLE sales IS 'This table stores tickets sales data';

O exemplo a seguir exibe o comentário na tabela SALES. 

select obj_description('public.sales'::regclass);

obj_description
-------------------------------------
This table stores tickets sales data

O exemplo a seguir remove um comentário da tabela SALES. 

COMMENT ON TABLE sales IS NULL;

O exemplo a seguir adiciona um comentário à coluna EVENTID da tabela SALES. 

COMMENT ON COLUMN sales.eventid IS 'Foreign-key reference to the EVENT table.';

O exemplo a seguir exibe um comentário na coluna EVENTID (coluna número 5) da tabela SALES. 

select col_description( 'public.sales'::regclass, 5::integer );

col_description
-----------------------------------------
Foreign-key reference to the EVENT table.

O exemplo a seguir adiciona um comentário descritivo à tabela EVENT. 

comment on table event is 'Contains listings of individual events.';

Para visualizar os comentários, faça uma consulta no catálogo do sistema PG_DESCRIPTION. O exemplo a seguir retorna a descrição da tabela 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.