O processo de documentação de um banco de dados SQL Server é um processo completo e contínuo que deve começar durante as fases de design e desenvolvimento do banco de dados e continuar durante todos os ciclos de vida relacionados ao banco de dados de forma a garantir uma versão atualizada da documentação do banco de dados que reflete a realidade em qualquer momento. Se executado corretamente, o arquivo de documentação do banco de dados gerado conterá uma lista atualizada e completa dos objetos do banco de dados e uma breve descrição desses objetos do banco de dados.
O processo de documentação do banco de dados SQL Server pode ser executado de várias maneiras. Você pode simplesmente criar um diagrama de banco de dados que mostre uma lista de todas as tabelas e colunas do banco de dados e atualize esse diagrama quando qualquer alteração for executada. Mas ler e manter tal diagrama não é um processo fácil para grandes bancos de dados com dezenas de tabelas de banco de dados com cada tabela contendo dezenas de colunas.
A partir do SQL Server 2005, a Microsoft introduziu um novo recurso chamado Propriedades Estendidas, que é armazenado no próprio banco de dados e acessado usando o objeto de sistema sys.extended_properties e retorna informações de metadados associadas ao banco de dados ou objetos de banco de dados especificados. Documentar o banco de dados SQL Server usando as propriedades estendidas não é a melhor escolha, pois você pode documentar um banco de dados por vez, nenhum dado histórico, pois as propriedades dos objetos do banco de dados serão excluídas quando esse objeto for excluído, não é um processo fácil pois requer boas habilidades de desenvolvimento, exige grande esforço e consome muito tempo.
Usando o Visual Studio
Os desenvolvedores que estão familiarizados com o Microsoft Visual Studio podem facilmente se beneficiar do tipo de projeto do SQL Server para se conectar a um banco de dados do SQL Server e verificar os metadados sobre os objetos do banco de dados.
Para isso, abra a ferramenta Visual Studio e crie um novo Projeto de Banco de Dados SQL Server na janela Novo Projeto, conforme abaixo:
Na janela Novo Projeto, forneça um nome exclusivo para esse projeto, onde salvá-lo e clique em OK para criar o Projeto de Banco de Dados SQL Server. Quando o projeto for criado, clique nas propriedades do projeto e configure o valor Target Platform com a versão SQL Server do banco de dados de destino, conforme mostrado abaixo:
Para se conectar a um banco de dados específico, clique com o botão direito do mouse no projeto criado e escolha a opção Importar -> Banco de Dados da seguinte forma:
Na janela Importar Banco de Dados, selecione uma conexão da lista de conexões salvas anteriormente ou forneça o nome do servidor, credenciais autenticadas e o nome do banco de dados para se conectar ao banco de dados a ser documentado, da seguinte forma:
Ao conectar no botão Conectar, a ferramenta começará a coletar informações de metadados sobre todos os objetos do banco de dados, conforme mostrado abaixo:
Após coletar e importar todas as informações do banco de dados, os objetos de banco de dados selecionados serão exibidos no gerenciador de soluções, categorizados por esquema, da seguinte forma:
Para visualizar informações de metadados sobre qualquer objeto de banco de dados, expanda o esquema do gerenciador de soluções e clique nesse objeto e uma nova janela será aberta mostrando toda a descrição do objeto selecionado, com script T-SQL para criar esse objeto específico, conforme mostrado abaixo:
Ele também oferece a capacidade de mostrar a coluna Descrição para cada objeto do banco de dados, clicando com o botão direito do mouse no espaço livre ao lado da tabela selecionada e escolhendo a opção Descrição. Uma nova coluna será exibida mostrando a descrição de cada coluna, com a possibilidade de editar a descrição, conforme mostrado abaixo:
Embora seja muito fácil documentar seu banco de dados usando o Visual Studio, ele não fornece um local centralizado para verificar vários objetos de banco de dados, fornece informações sobre um único banco de dados para cada projeto e não pode ser exportado para um formato amigável ou imprimível!
Usando o dbForge Documenter para SQL Server
Para economizar tempo e esforço e manter a documentação do banco de dados atualizada, é melhor usar uma ferramenta de terceiros que facilite o processo de documentação. O dbForge Documenter for SQL Server é uma ferramenta de documentação de banco de dados que pode ser facilmente conectada ao seu banco de dados e gera documentação de todos os objetos de banco de dados SQL Server em apenas alguns cliques.
O dbForge Documenter for SQL Server nos fornece uma ampla variedade de modelos e opções de estilo que ajudam a personalizar a documentação gerada para atender aos seus próprios requisitos. Em poucos segundos de configuração, o dbForge Documenter for SQL Server extrai todas as informações e detalhes extensivos sobre o banco de dados selecionado, bem como dependências entre objetos e scripts DDL T-SQL para criar esses objetos, com capacidade de exportar a documentação em HTML pesquisável , PDF e formatos de arquivo Markdown. O formato HTML ajuda na publicação do banco de dados na web e o formato PDF é adequado para distribuição em outros sistemas e compartilhado com outros dispositivos. O dbForge Documenter for SQL Server também pode ser acessado para documentar o banco de dados diretamente por meio do SQL Server Management Studio, pois é integrado ao SSMS.
O dbForge Documenter for SQL Server pode ser baixado do centro de download do Devart e instalado em seu servidor através do assistente de instalação simples, conforme abaixo:
Ao clicar no botão Instalar para iniciar o processo de instalação, você será solicitado a especificar o caminho de instalação da ferramenta, caso consiga criar um ícone na área de trabalho para que a ferramenta acesse mais rapidamente, as versões do SQL Server Management Studio para tenha esta ferramenta como add-in nela, as extensões de arquivos que serão associadas à ferramenta dbForge Documenter for SQL Server e, finalmente, você será solicitado a especificar o modo de otimização de inicialização para a ferramenta. Depois disso, o processo de instalação será iniciado, com uma útil barra de progresso que mostra o que está sendo instalado agora, conforme mostrado abaixo:
Quando o processo de instalação for concluído com êxito, o assistente o notificará e fornecerá a opção de iniciar a ferramenta diretamente, da seguinte maneira:
A primeira visualização do dbForge Documenter for SQL Server será semelhante à janela abaixo. Para criar documentação para seu banco de dados usando o dbForge Documenter for SQL Server, clique na janela New Documentation na página de boas-vindas, conforme abaixo:
Na janela de documentação aberta, clique em Add Connection para selecionar uma conexão existente ou adicionar uma nova conexão, fornecendo o nome do servidor, credenciais válidas e o nome do banco de dados ao qual se conectar, usando a página amigável abaixo:
Após conectar-se com sucesso ao banco de dados, o dbForge Documenter for SQL Server listará todos os bancos de dados e objetos de banco de dados na instância do SQL Server conectada. No início, ele oferece a opção de fornecer um nome e uma descrição exclusivos para a documentação a ser gerada, além de seu próprio logotipo, nome e data a serem exibidos nessa documentação, conforme mostrado abaixo:
Para documentar um banco de dados específico ou objetos de banco de dados, verifique o nome do banco de dados na lista de bancos de dados, revise e ajuste as diferentes propriedades e opções do banco de dados a serem incluídas na documentação, mas ative ou desative o botão incluir ao lado de cada propriedade e opção, como mostrado abaixo:
Após personalizar o que incluir em sua documentação, clique na opção Gerar para gerar a documentação do banco de dados, com base em suas seleções, conforme a seguir:
Na janela Gerar Documentação, especifique o formato da documentação gerada e o caminho e característica do nome do arquivo gerado, conforme mostrado abaixo:
Se você clicar no botão Gerar, o processo de geração de documentação será iniciado, com uma lista de verificação amigável e uma barra de progresso para mostrar o status atual do processo de geração, conforme abaixo:
Quando o processo de geração de documentação for concluído com sucesso, o dbForge Documenter for SQL Server irá notificá-lo com o resultado final, conforme abaixo:
Navegando até o caminho onde o arquivo está salvo, você verá que a documentação do banco de dados é gerada nesse caminho em formato PDF, conforme mostrado abaixo:
O relatório será aberto também na ferramenta dbForge Documenter for SQL Server, mostrando a descrição do banco de dados, lista de todos os objetos e arquivos do banco de dados e as propriedades e opções do banco de dados selecionado, conforme mostrado abaixo:
O dbForge Documenter for SQL Server também oferece a capacidade de mergulhar profundamente em cada objeto de banco de dados. Por exemplo, clique no hiperlink Tabelas, escolha a tabela de seu interesse e as informações completas sobre a tabela selecionada serão exibidas no relatório, conforme mostrado abaixo:
Fica claro no exemplo abaixo, como podemos usar a ferramenta dbForge Documenter for SQL Server 3rd party em poucos cliques para gerar documentação personalizável para seus bancos de dados, que pode ser usada para vários propósitos. Vá e tente documentar seu banco de dados usando o dbForge Documenter for SQL Server!
