Ol\u00e1 pessoal, boa tarde!<\/p>\n
Estamos prestando uma consultoria \u00e0 um \u00f3rg\u00e3o governamental que possui um banco de dados em PostgreSQL bastante extenso. Uma de nossas tarefas era documentar o banco de dados todo, incluindo a cria\u00e7\u00e3o de um dicion\u00e1rio de dados compreensivo, com informa\u00e7\u00f5es sobre as tabelas, views, procedures, etc.<\/p>\n
Como o banco \u00e9 grande<\/strong>, possuindo muitos objetos, decidimos criar uma solu\u00e7\u00e3o simples em Python<\/em> que conecta-se ao banco de dados e utilizando um template, escreve o dicion\u00e1rio para n\u00f3s, baseados nos coment\u00e1rios existentes para cada objeto.<\/p>\n No PostgreSQL, acredito que quase todos os objetos do banco possuem um campo de coment\u00e1rio, ou seja, ao inv\u00e9s da documenta\u00e7\u00e3o ficar somente no papel, ela fica diretamente armazenada no campo de coment\u00e1rio de cada objeto, podendo ser consultada por quem j\u00e1 tem permiss\u00e3o aquele determinado objeto. \u00c9 uma ideia simples, mas funcional.<\/p>\n Para inserir os coment\u00e1rios em lote, geramos um arquivo .yaml estruturado, onde as descri\u00e7\u00f5es podem ser preenchidas e posteriormente sincronizadas com o banco de dados. Outro utilit\u00e1rio, gera a documenta\u00e7\u00e3o no formato de um template, podendo o mesmo ser customizado.<\/p>\n Ainda precisa de algumas mudan\u00e7as e cria\u00e7\u00e3o de testes para ficar um pouco mais modular, mas basicamente conseguimos ler todo o cat\u00e1logo do PostgreSQL e gerar esta documenta\u00e7\u00e3o em pouqu\u00edssimo tempo.<\/p>\n Outras funcionalidades veem a mente:<\/p>\n\n