Postgres - Autodoc

De Pontão Nós Digitais
Revisão de 15h00min de 18 de dezembro de 2015 por Felipecabral (discussão | contribs)

Postgres autodoc é um software via command line que le tabelas PostgreSQL e retornar ficheiros HTML, DOT, e 2 estilos de XML, os quais descrevem a base de dados.

O HTML é humanamente legível (através de um navegador). O primeiro estilo XML é efectivamente o formato de ficheiro do Dia, uma ferramenta de diagramas UML. O segundo estilo XML é semelhante ao HTML mas no formato Docbook 4. Permite-lhe misturar com outros documentos Docbook através das XREFs, gerar PDFs, HTML, RTF, ou outros documentos formatados. Entre estas ferramentas e o Javadoc com os XREFs apropriados, documentação sobre um projecto pode ser gerada rapidamente e ser facilmente actualizável e no entanto ter um aspecto bastante profissional com algum trabalho DSSSL.

Com instalar?

Você precisa do Postgres rodando antes de rodar.

 # apt-get install postgresql

Depois instale o autodoc:

 # apt-get install postgresql-autodoc

Outras ferramentas interessantes para processamento conjunto (faça a instalação também):

 # apt-get install graphviz
 # apt-get install dia

Para gerar o modelo .dot:

 $ postgresql_autodoc -t dot -h nome-do-hostname -u nome-do-username -d nome-da-databasename --password

Para gerar o modelo em png:

 $ dot -Tpng nome-da-databasename.dot -o nome-do-modelo.png

Referências