DBDocumentor

DBDocumentor produz documentação de banco de dados para os objetos SQL em seu projeto de banco de dados. A lista de objetos SQL documentados varia com o dialeto SQL escolhido, e DBDocumentor atualmente suporta; Microsoft SQL Server 2005 e inferior, Firebird 1.5 e 2.0 e Sybase SQL Anywhere 10 e inferior (o SQL Anywhere era anteriormente comercializado como Adaptive Server Anywhere ou ASA). Gerar documentação de referência para um banco de dados SQL usando DBDocumentor é tão simples quanto selecionar o dialeto SQL, os tipos de objetos a serem incluídos e os arquivos de origem a serem processados. Em poucos minutos, o DBDocumentor gera uma visão totalmente com referência cruzada do banco de dados SQL, incluindo a origem dos dados e quais objetos estão modificando os dados em quais outros objetos. A referência cruzada se estende a procedimentos e uso de segurança, mostrando claramente quais procedimentos são usados, onde e em que contexto de segurança.  

A documentação produzida pelo DBDocumentor é perfeita como documentação impressa do aplicativo de banco de dados para:

1. Documentação do cliente para projetos de consultoria de desenvolvimento de software.
2. Acesso online para desenvolvedores de camada intermediária desenvolverem em uma interface de banco de dados documentada.
   
3. Esforços de garantia de qualidade para garantir que as diretrizes de codificação consistentes sejam seguidas.
   
4. Determinar o grau de exposição de dados e risco por funções e procedimentos específicos de banco de dados.
   
5. Determinar o grau de SQL dinâmico usado no banco de dados e quais fontes de dados são afetadas pelo uso de SQL dinâmico.
   
6. Determinar quais dados são expostos por meio de relatórios do Microsoft SQL Server Reporting Services.
   

A documentação produzida pelo DBDocumentor também pode ser produzida no início dos projetos para ajudar a definir o contrato de interface entre a camada de banco de dados e seus consumidores, onde o acesso aos dados ocorre por meio de procedimentos armazenados, funções definidas pelo usuário ou visualizações de dados. As técnicas de design orientado a objetos já existem há algum tempo e todas elas têm um princípio orientador de definir as interfaces para objetos e aderir a essas interfaces, geralmente chamadas de contratos. Os procedimentos de banco de dados oferecem a capacidade de definir interfaces SQL, mas as ferramentas para documentar de fato a interface são raras. DBDocumentor é uma dessas ferramentas.

Os recursos estendidos do rico conjunto de recursos incluem agrupamento declarativo de objetos, suporte para descrições baseadas em metadados DBMS como aquelas fornecidas no SQL Server Enterprise Manager ou SQL Server Management Studio, codificação de cores de sintaxe específica de dialeto SQL, controle sobre a documentação de objetos temporários e SQL dinâmico , facilidade de integração em ambientes de construção automatizados e geração de saída XML. Toda a documentação é gerada pela leitura dos arquivos em lote SQL de origem e não requer nenhuma conexão de banco de dados ativa ou quaisquer ferramentas de conectividade de banco de dados. Os benefícios de um analisador SQL offline são muitos e incluem a capacidade de documentar a estrutura do conjunto de resultados, valores de retorno e pontos de acesso a dados.  

Proveedor: Pikauba Software

Ver descripción detallada