Compartilhar via

SQL Server: Documentando um Banco de Dados

  • Artigo

RASCUNHO: Artigo em desenvolvimento

Introdução

Este artigo é sobre uma importante tarefa no desenvolvimento de um banco de dados, mas que muitas pessoas têm dificuldades em priorizar: a documentação de objetos de um banco de dados.

O objetivo deste artigo é apresentar uma forma de documentar apenas as tabelas de um banco de dados e apresentar a construção de diagramas para equipes de desenvolvimento de software e tornar mais fácil a compreensão dos dados armazenados, de acordo com uma determinada estrutura de dados. 

A normalização do banco de dados é algo muito mais abrangente e pode ser influenciada por questões de metodologia de cada corporação, o que foge do escopo deste artigo.

       

Necessidade

Existem banco de dados que não possuem padronização e nem documentação adequada. Com o passar do tempo isto se torna um problema para todos que precisam manipular ou apenas consultar seus dados. Em alguns casos, somente é possível interpretar a estrutura do banco de dados com ajuda de um dos desenvolvedores vinculado ao seu projeto original. Isto torna todo o trabalho de manutenção e melhoria deste tipo de banco de dados e dos sistemas que consomem seus recursos muito mais difícil e lento, consequentemente, mais caros.

A documentação é fundamental e deve ser considerada como requisito mínimo para o bom andamento de um projeto de banco de dados.

Vamos apresentar alguns comandos simples para tornar essa documentação um processo prático. Com o tempo você pode tornar a documentação de suas tabelas uma simples rotina no seu trabalho.

Como Adicionar um Comentário

A inclusão de comentários em tabelas é diferente dos comentários tradicionais em Transact-SQL, definidos por "--" ou "/* */". Você pode utilizar Propriedades Extendidas para descrever todos os objetos do seu banco de dados, mas vamos nos concentrar apenas nas tabelas.

Referências

 

Veja Também

 

Outros Idiomas