SchemaSpy Maven Plugin

Maven Plugin For SchemaSpy

License

License

Categories

Categories

Maven Build Tools
GroupId

GroupId

red.sukun1899
ArtifactId

ArtifactId

schemaspy-maven-plugin
Last Version

Last Version

1.2.1
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

SchemaSpy Maven Plugin
Maven Plugin For SchemaSpy
Project URL

Project URL

https://github.com/su-kun1899/schemaspy-maven-plugin
Source Code Management

Source Code Management

https://github.com/su-kun1899/schemaspy-maven-plugin

Download schemaspy-maven-plugin

How to add to project

<plugin>
    <groupId>red.sukun1899</groupId>
    <artifactId>schemaspy-maven-plugin</artifactId>
    <version>1.2.1</version>
</plugin>

Dependencies

compile (7)

Group / Artifact Type Version
org.apache.maven : maven-compat jar 3.3.9
org.apache.maven : maven-plugin-api jar 3.2.5
org.codehaus.plexus : plexus-utils jar 3.0.24
mysql : mysql-connector-java jar 5.1.6
com.googlecode.log4jdbc : log4jdbc jar 1.2
ch.qos.logback : logback-classic jar 1.1.7
org.slf4j : slf4j-api jar 1.7.21

provided (1)

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

test (2)

Group / Artifact Type Version
junit : junit jar 4.12
org.apache.maven.plugin-testing : maven-plugin-testing-harness jar 3.3.0

Project Modules

There are no modules declared in this project.

schemaspy-maven-plugin

schemaspy-maven-plugin is maven plugin for SchemaSpy.

SchemaSpy is graphical database schema metadata browser. It is a Java-based tool that analyzes the metadata of a schema in a database, and generates a visual representation of it in html format.

This plugin may help some maven projects and developers.

Metadata are...

  • Tables
  • Columns
  • Indexes
  • Constraints
  • RelationShips
  • etc

Requirement

schemaspy-maven-plugin requires...

  • java 1.8.x
  • maven 3.3.x

Usage

pom.xml setting

<project ...>
    ...
      <build>
        <plugins>
          <plugin>
            <groupId>red.sukun1899</groupId>
            <artifactId>schemaspy-maven-plugin</artifactId>
            <version>1.1.0</version>
            <configuration>
              <databaseType>mysql</databaseType>
              <host>yourDatabaseHost</host>
              <user>yourDatabaseUser</user>
              <password>yourDatabasePassword</password>
              <dbName>yourDatabaseName</dbName>
              <outputDirectory>pathForGeneretedHtml</outputDirectory>
            </configuration>
          </plugin>
        </plugins>
      </build>
</project>

Generate Html

mvn red.sukun1899:schemaspy-maven-plugin:schemaspy

Sample Project

see schemaspy-plugin-sample

Caution

  • Currently Supported Only MySQL

Release

This is the item for project owners.
It is how to deploy to maven central repository.

git tag -a vX.X.X
mvn clean deploy -DperformRelease=true -s settings.xml -P release
git push origin vX.X.X

Versions

Version
1.2.1
1.2.0
1.1.0
1.0.2