Adicionar comentários em tabelas do SQL Server

Olá!

Por padrão o SQL Server não tem comentário assim como em outros bancos de dados (Oracle, PostgreSQL, MySQL, etc …) então você pode utilizar o recurso Extended Properties para fazer isso.

Abaixo, está o código para adicionar comentário em uma tabela específica:

EXEC sp_addextendedproperty 
    @name = N'MS_Description', 
    @value = 'Descrição da tabela de clientes', 
    @level0type = N'SCHEMA', @level0name = 'dbo', 
    @level1type = N'TABLE', @level1name = 'cliente';

@name = N’MS_Description’: É o nome da propriedade. MS_Description é o padrão usado pelo SQL Server Management Studio (SSMS) para exibir comentários na interface gráfica.

@value = ‘Descrição da tabela’: Aqui será adicionado o texto com a descrição da funcionalidade da tabela.

@level0type = N’SCHEMA’: O tipo de nível superior (geralmente o Schema)

@level0name = ‘dbo’: Nome do schema onde a tabela reside

@level1type = N’TABLE’: O tipo de objeto que receberá a descrição

@level1name = ‘cliente’: Nome da tabela que irá receber o comentário

Se você quiser adicionar comentários em uma coluna de uma tabela específica, rode o seguinte comando:

EXEC sp_addextendedproperty 
    @name = N'MS_Description', 
    @value = 'Nome completo do cliente', 
    @level0type = N'SCHEMA', @level0name = 'dbo', 
    @level1type = N'TABLE', @level1name = 'cliente', 
    @level2type = N'COLUMN', @level2name = 'Nome';

E para visualizar os comentários tanto de colunas como tabelas rode o seguinte SELECT:

SELECT 
    obj.name AS Tabela,
    col.name AS Coluna,
    ep.value AS Descricao
FROM 
    sys.extended_properties ep
    LEFT JOIN sys.tables obj ON ep.major_id = obj.object_id AND ep.minor_id = 0
    LEFT JOIN sys.columns col ON ep.major_id = col.object_id AND ep.minor_id = col.column_id
WHERE 
    ep.name = 'MS_Description';