dbdoc Maven Plugin

Database documentation maven plugin

License	MIT License
Categories	Maven Build Tools
GroupId	io.github.jdlopez
ArtifactId	dbdoc-maven-plugin
Last Version	1.3
Release Date	Apr 10, 2018
Type	maven-plugin
Description	dbdoc Maven Plugin Database documentation maven plugin
Project URL	https://github.com/jdlopez/dbdoc-maven-plugin
Source Code Management	https://github.com/jdlopez/dbdoc-maven-plugin.git

Download dbdoc-maven-plugin

Filename	Size
dbdoc-maven-plugin-1.3.pom
dbdoc-maven-plugin-1.3.jar	26 KB
dbdoc-maven-plugin-1.3-sources.jar	15 KB
dbdoc-maven-plugin-1.3-javadoc.jar	68 KB

How to add to project

Apache Maven

<plugin>
    <groupId>io.github.jdlopez</groupId>
    <artifactId>dbdoc-maven-plugin</artifactId>
    <version>1.3</version>
</plugin>

Dependencies

compile (4)

Group / Artifact	Type	Version
org.apache.maven : maven-plugin-api	jar	3.0
org.codehaus.plexus : plexus-utils	jar	3.0.8
com.fasterxml.jackson.core : jackson-databind	jar	2.5.3
com.github.spullara.mustache.java : compiler	jar	RELEASE

provided (1)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.4

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.8.2

Project Modules

There are no modules declared in this project.

dbdoc maven plugin

A maven plugin that builds documentation from jdbc source. Now (1.2) added config file entries documentation from source

• Uses JSON file to add comments and extra documentation for tables or columns.
• Uses mustache templates. Basic HTML template
• v1.2 Config entries documentation. Very simple search for patterns in files (getProperty ... configurable)
• v1.3 Minor fix (deleted tables and columns)

Full usage example here

Basic example in pom.xml:

            <plugin>
            <groupId>io.github.jdlopez</groupId>
            <artifactId>dbdoc-maven-plugin</artifactId>
            <version>1.3</version>
            <configuration>
                <jdbcDriver>${jdbc.driver}</jdbcDriver>
                <jdbcUrl>${jdbc.url}</jdbcUrl>
                <jdbcUser>${jdbc.user}</jdbcUser>
                <jdbcPass>${jdbc.password}</jdbcPass>
                <cfgOverwriteSource>true</cfgOverwriteSource>
                <overwriteSource>false</overwriteSource>
            </configuration>
            <!-- add jdbc driver depends -->
            <dependencies>
                <dependency>
                    <groupId>org.hsqldb</groupId>
                    <artifactId>hsqldb</artifactId>
                    <version>2.4.0</version>
                </dependency>
            </dependencies>
            <executions>
                <execution>
                    <id>dbdoc</id>
                    <phase>site</phase>
                    <goals>
                        <goal>dbdoc</goal>
                    </goals>
                </execution>
                <execution>
                    <id>dbconfig</id>
                    <phase>site</phase>
                    <goals>
                        <goal>configdoc</goal>
                    </goals>
                </execution>
            </executions>

Check target/site generated files

It tests database with hsqldb

Versions

Version
1.3 Apr 10, 2018
1.2 Mar 2, 2018
1.1 Feb 22, 2018