FAQs

Examples

The first thing to try after downloading the SchemaCrawler distribution is the examples. Several examples on how to use SchemaCrawler on the command line, as an ant task or Maven plugin, as an API, as well as how to use the Apache Velocity (templating) integration and how to create database diagrams with Graphviz are provided in the _distrib/examples directory.

How-tos

Once you start getting comfortable with SchemaCrawler, and need to know more about how to do things, read the how-tos section.

Whitepapers and Documentation

To read more about SchemaCrawler, you can read:

• Java API Makes Database Metadata as Easily Accessible as POJOs for an introduction to the SchemaCrawler API. (This article may refer to an older release of the SchemaCrawler API, but the concepts are the same.)
• The SchemaCrawler API javadocs .

ant Build

The ant build is a quick build that builds the SchemaCrawler jar without running unit tests. Download ant and run it from the SchemaCrawler directory. The SchemaCrawler jar file will be created in the _distrib directory. The main targets are all.build and all.clean.

Maven Build

The Maven build is a more comprehensive build that runs unit tests, and can also create the project web-site. Download Maven 2.0. Then run mvn package from the SchemaCrawler directory. The SchemaCrawler distribution will be created in the target of the distribution module.

Eclipse

Before importing the various SchemaCrawler projects into Eclipse, make sure that you have a successful Maven build. Maven will download all the dependencies needed to build SchemaCrawler. Also, install the m2eclipse Maven Integration for Eclipse plugin.