COMMENT ON [ [ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ] nome_do_objeto | COLUMN nome_da_tabela.nome_da_coluna | AGGREGATE nome_da_agregação (tipo_da_agregação) | FUNCTION nome_da_função (arg1, arg2, ...) | OPERATOR op (leftoperand_type rightoperand_type) | TRIGGER nome_do_gatilho ON nome_da_tabela ] IS 'texto'
O comando COMMENT armazena um comentário sobre um objeto do banco de dados. Os comentários podem ser facilmente acessados através dos comandos \dd, \d+ e \l+ do psql. Outras interfaces de usuário podem acessar os comentários utilizando as mesmas funções nativas usadas pelo psql, que são: obj_description() e col_description().
Para modificar um comentário basta executar novamente o comando COMMENT para o mesmo objeto. Somente um único comentário é armazenado para cada objeto. Para excluir um comentário escreva NULL no lugar do texto. O comentário é automaticamente excluído quando o objeto é excluído.
Deve ser observado que não existe atualmente nenhum mecanismo de segurança para os comentários: qualquer usuário conectado ao banco de dados pode ver todos os comentários dos objetos do banco de dados (embora somente um superusuário possa modificar comentários de objetos que não lhe pertencem). Portanto, não coloque informações confidenciais nos comentários.
Adicionar um comentário à tabela minha_tabela:
COMMENT ON minha_tabela IS 'Esta tabela é minha.';
Alguns outros exemplos:
COMMENT ON DATABASE bd_desenv IS 'Banco de dados de desenvolvimento'; COMMENT ON INDEX idx_func_id IS 'Garante a unicidade do identificador do funcionário'; COMMENT ON RULE upd_func IS 'Registra as atualizações dos registros dos funcionários'; COMMENT ON SEQUENCE seq_func IS 'Gera a chave primária dos funcionários'; COMMENT ON TABLE tbl_func IS 'Cadastro dos funcionários'; COMMENT ON TYPE tipo_cn IS 'Suporte a números complexos'; COMMENT ON VIEW vis_dep_custo IS 'Visão dos custos dos departamentos'; COMMENT ON COLUMN tbl_func.id_func IS 'Identificador do funcionário'; COMMENT ON AGGREGATE agreg_var (double precision) IS 'Calcula a variância da amostra'; COMMENT ON FUNCTION func_romano (int) IS 'Retorna o número em algarismos romanos'; COMMENT ON OPERATOR ^ (text, text) IS 'Realiza a interseção de dois textos'; COMMENT ON TRIGGER gat_func ON tbl_func IS 'Utilizado para integridade referencial';