A Maven 2 plugin for the SchemaSpy

does it integrate as a report?

On config params (which are not in the Jir issue).

the hibernate3 plugin allows you to specify a properties file for the jdbc configuration. For me this is a good choice becuse it keeps the usernames and passwords out of the repository.

I think you pretty much need to use an external properties files and/or use a server element in the settings.xml so you don't have to check in a password to SVN / CVS. NOw that I think about it, I'd prefer a server definition in the settings.xml but I'd be happy with both.

I just added a jdbcUrl configuration option, which lets you specify the JDBC URL directly rather then counting on SchemaSpy to generate it.

To give a better idea of how the plugin works, here is a copy of the web site usage page:

The SchemaSpy plugin generates SchemaSpy reports describing a relational database. It will look for an appropriate JDBC driver on the classpath (based on the database type), and by default will generate a report in the 'target/site/schemaspy' directory. To include a report in your project site, set the following in the <reporting> section of your pom:

<project>
...
<reporting>
<plugins>
<plugin>
<groupId>com.wakaleo.maven.plugin.schemaspy</groupId>
<artifactId>maven-schemaspy-plugin</artifactId>
<version>1.0</version>
<configuration>
<databaseType>mysql</databaseType>
<database>testdb</database>
<host>localhost</host>
<user>scott</user>
<password>tiger</password>
</configuration>
</plugin>
</plugins>
</reporting>
</project>
Configuration
SchemaSpy (see JXR plugin) . The SchemaSpy plugin accepts all of the standard SchemaSpy parameters.

Most databases with JDBC drivers available in the standard Maven repository should work out-of-the-box. Currently, these are: * Derby * MySQL * HSQLDB * PostgreSQL * MS SQLServer using the JTDS driver (mssql-jtds) Others, such as DB2, Oracle, MS SQL Server (if using the Microsoft driver) and Firefox, don't have drivers in the repositories.

In this case, or if you want to specify a different driver, you need to specify the driver manually using the <pathToDrivers> parameter:

<project>
...
<reporting>
<plugins>
<plugin>
<groupId>com.wakaleo.maven.plugin.schemaspy</groupId>
<artifactId>maven-schemaspy-plugin</artifactId>
<version>1.0</version>
<configuration>
<databaseType>mysql</databaseType>
<database>testdb</database>
<host>localhost</host>
<user>scott</user>
<password>tiger</password>
<outputDirectory>target/site/schemaSpy-full</outputDirectory>
<pathToDrivers>src/test/resources/lib/derby-10.1.2.1.jar</pathToDrivers>
<commentsInitiallyDisplayed>true</commentsInitiallyDisplayed>
<noTableComments>true</noTableComments>
<noImplied>true</noImplied>
<allowHtmlInComments>true</allowHtmlInComments>
<cssStylesheet>testSchemaSpy.css</cssStylesheet>
<schemaDescription>Maven Plugin SchemaSpy Test</schemaDescription>
</configuration>
</plugin>
</plugins>
</reporting>
</project>
For MSSQL Server, the mssql-jtds will use the open source JTDS driver for this database.

Rather than defining the database and host names and letting SchemaSpy build the URL, you can alternatively specify the complete JDBC URL using this parameter. If this parameter is defined, it will override the host address (which, as a result, is not needed). Note that you still need to specify the database type, since SchemaSpy uses its own database properties file for extra information about each database.

<project>
...
<reporting>
<plugins>
<plugin>
<groupId>com.wakaleo.maven.plugin.schemaspy</groupId>
<artifactId>maven-schemaspy-plugin</artifactId>
<version>1.0</version>
<configuration>
<databaseType>mysql</databaseType>
<jdbcUrl>jdbc:mysql://localhost/testdb</jdbcUrl>
<user>scott</user>
<password>tiger</password>
</configuration>
</plugin>
</plugins>
</reporting>
</project>
As a rule, it is not a good idea to keep usernames and passwords in the source code repository. An alternative is to define the user and password values in your setting.xml file, as shown here:

<settings>
<localRepository>C:/maven/repository</localRepository>
<profiles>
<profile>
<id>development</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<schemaspy.username>john</schemaspy.username>
<schemaspy.password></schemaspy.password>
</properties>
</profile>
</profiles>
</settings>

With this setup, you can use the $schemaspy.username and $schemaspy.password values directly in your SchemaSpy plugin configuration:

<project>
...
<reporting>
<plugins>
<plugin>
<groupId>com.wakaleo.maven.plugin.schemaspy</groupId>
<artifactId>maven-schemaspy-plugin</artifactId>
<version>1.0</version>
<configuration>
<database>testdb</database>
<jdbcUrl>jdbc:mysql://localhost/testdb</jdbcUrl>
<user>$

</user>
<password>$

</password>
</configuration>
</plugin>
</plugins>
</reporting>
</project>

I've made a patch for the maven-schemaspy-plugin which:
1) Allows to have only JDBC URL (no DB name) provided in plugin configuration.
2) Make the JUnit tests more reliable.
3) Patch embedded SchemaSpy code not to use System.exit() but to throw exceptions when an error occurs.
and some other minor improvements.

And here it is - SchemaSpy 4.0.0 from 19.09.2008 - http://sourceforge.net/project/showfiles.php?group_id=137197

When this plugin will hosted be by codehaus ?

Thanks

> Damien Lecan - 30/Sep/08 04:55 AM
> When this plugin will hosted by codehaus ?

Exactly, it would be helpful. In the meantime I am forking it in my own repo and making patches...

Regards,
Krystian

> In the meantime I am forking it in my own repo and making patches...

Publish it instead of the original one
I'd like to see jdbc jar as a possible plugin dependency ...

patch to add port configuration for schemaspy call