pdgen

README

PDGEN - Data Dictionary Generator

This software has as objective to resolve the problem of maintain the data dictionary actualized when work in agile project that use the migrations to create, update or delete tables, views and schemas.

✏   Before start use this software is strongly recommended to have a well documented database, that are comments for all elements like columns, tables, views, schemas and database.

Basically this is an automatic data dictionary generator that use the informations present at the database to export well organized documents. Actually the output formats are:

• Console: This is de default one that outputs directly over the operation system stdout;
• TXT: Generate a TXT file containing the organized information;
• HTML: Generate an HTML file containing the organized information;
• Markdown (MD): Generate a MD file containing the organized information;
• DOCX: 👷 Previewed at version 2.0.0 🚧

The output can be done by now in the follow languages:

• en: English (default alias for en-US);
• en-US: American english;
• fr: French (default alias for fr-CA);
• fr-CA: Canadian French;
• pt: Portuguese (default alias for pt-BR);
• pt-BR: Brazilian portuguese.

The Install and Usage documentation are disponible at: PDGEN Home Page

Documentation

Overview

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.