terça-feira, 24 de janeiro de 2006

OraSchemaDoc

Em minha busca constante por melhorias no processo de documentação de minha empresa, me deparei com o problema de documentação de banco de dados. A gente acaba criando várias tabelas, com vários campos, vamos modificando tudo isso através do tempo, e acabamos perdendo o significado das coisas, pois não documentamos. No oracle, podemos inserir comentários para cada tabela e campo criado, mas é penoso ter que abrir o PL/SQL pra achar uma tabela, visualizá-la e achar o comentário de um campo. Pensei então que seria bom ter uma documentação a la javadoc pros nossos bancos. Googleando, encontrei o OraSchemadoc , uma ferramenta que faz justamente isto. Você indica o banco que você deseja documentar, e ele cria uma estrutura html com documentação das tabelas, triggers, function, views, procedures e outras coisas mais. Bastante útil para equipes como a nossa, onde as mudanças são constantes, e temos pouco tempo para documentá-las.

Para utilizar esta ferramenta você precisa ter Python (versão 2.0 ou superior), e a biblioteca cx_Oracle para fazer a conexão entre o Python e o Oracle.

Se você já conhece a ferramenta, ou conhece outras alternativas, dê seu testemunho a respeito. Será bastante benvindo.

Nenhum comentário: