Describe e Comments no SQL Server

Natal DevMedia: Assine hoje e ganhe 3 meses gr�tis

Um dos comandos bastante utilizados no Oracle para verificar estrutura de tabelas e tipos de campos � o comando DESC abrevia��o de describe, descrever.

Este comando descreve a estrutura de tabelas com suas colunas e tipo de dados.

O SQL Server possui DESC para �descrever� uma tabela?

Na realidade n�o, o SQL Server trabalha com estes comandos de uma forma um pouco diferente.

O Oracle possui comandos, que s�o nomes reservados para determinadas fun��es.

O SQL Server trabalha com system stored procedures, procedimentos armazenados do sistema, estes s�o respons�veis por armazenar blocos T-SQL que buscam informa��es.

Um destes procedimentos o qual usamos para esta mesma finalidade � o sp_columns este procedimento resulta em uma busca de todas as informa��es sobre os campos de uma determinada tabela. Como no exemplo:

�

use [AdventureWorks]

�

sp_columns AWBuildVersion

AWBuildVersion	SystemInformationID	-6	tinyint identity	3	1	0	10	NULL	NULL	-6	NULL	NULL	1	NO	48
AWBuildVersion	Database Version	-9	nvarchar	25	50	NULL	NULL	NULL	NULL	-9	NULL	50	2	NO	39
AWBuildVersion	VersionDate	11	datetime	23	16	3	NULL	NULL	NULL	9	3	NULL	3	NO	61
AWBuildVersion	ModifiedDate	11	datetime	23	16	3	NULL	NULL	(getdate())	9	3	NULL	4	NO	61

�

Al�m disto, � uma boa pr�tica comentarmos em nosso banco de dados qual a serventia de cada campo, tabela, enfim, � sempre extremamente importante qualquer tipo de documenta��o.

Banco de dados tamb�m possui recursos para deixarmos tudo bem documentado.

O Oracle possui:

COMMENT ON TABLE TABELA IS 'Descri��o da tabela'

COMMENT ON COLUMN TABELA.CAMPO IS 'Descri��o sobre utiliza��o do campo'

Pois bem, o SQL Server possui uma forma diferenciada de trabalhar com estas �documenta��es�.

O SQL Server possui uma lista de propriedades estendidas, extend property. Nesta lista � poss�vel dar nome a propriedade desejada e incluir informa��es sobre ela.

Por exemplo, criar duas ou mais propriedades estendidas, uma identificando para que serve o campo e outra explicando a representa��o dos valores.

A nomenclatura padr�o do SQL Server para propriedade � MS_Description outras mais ficam a customiza��o de cada DBA.

Campo Sexo:

Descri��o: Campo que identifica sexo do cliente.

Valores: M representa Masculino e F representa Feminino.

Ent�o vamos para pr�tica:

Coment�rio de Tabela

EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'Current version number of the AdventureWorks sample database. ' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'AWBuildVersion'

TABLE

AWBuildVersion

Current version number of the AdventureWorks sample database.�

Coment�rio de coluna

EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'Date and time the record was last updated.' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'AWBuildVersion', @level2type=N'COLUMN',@level2name=N'ModifiedDate'

�

COLUMN	SystemInformationID	Primary key for AWBuildVersion records.
COLUMN	Database Version	Version number of the database in 9.yy.mm.dd.00 format.
COLUMN	VersionDate	Date and time the record was last updated.
COLUMN	ModifiedDate	Date and time the record was last updated.

Estas propriedades podem ser acessadas atrav�s do SQL Server Management Studio visualizando as propriedades do campo ou tabela que deseja consultar ou uma consulta no banco de dados que retorna estes dados:

Consulta descri��o da tabela
SELECT objtype, objname, value
FROM fn_listextendedproperty
('MS_Description', 'schema', 'dbo', 'table', default, NULL, NULL)
where objname = 'AWBuildVersion'

Consulta descri��o das colunas

SELECT objtype, objname, value

FROM fn_listextendedproperty

('MS_Description', 'schema', 'dbo', 'table', 'AWBuildVersion', 'column', default)

�

Para concluirmos caso necessite maiores informa��es sobre uma determinada tabela, pode ser utilizado uma SP que � bastante utilizada no SQL Server sp_help basta utilizar este comando passando a tabela que seja visualizar informa��es, como segue na imagem.

�