Pre-requisites for Installation
- Install the latest version of Java
- Optionally, install Graphviz if you want to create database diagrams
- Optionally, install Apache ant and Apache Maven if you want to try out the examples
Installing SchemaCrawler is as simple as unzipping a file. First, download the SchemaCrawler distribution with examples zip file, and unzip it into a directory. You will have the SchemaCrawler distribution in a directory called
_schemacrawler. There are detailed instructions with the download.
You can extend the SchemaCrawler distribution by downloading additional libraries that SchemaCrawler integrates with, such as the pure Java Graphviz library, Spring Framework, Groovy, Ruby, Python and so on. You can also download additional JDBC drivers, and have SchemaCrawler pick them up automatically. Once you are happy with the customization of your installation, you can copy the
_schemacrawler folder to any location on your system, and use it from there.
Also read the Scribe Tools Read The Docs guide.
The first thing to try is the SchemaCrawler examples.
SchemaCrawler provides detailed command-line help. Simply run
schemacrawler.sh on Unix) with no command-line arguments for help.
Connecting To Your Database
Read information about database support carefully to understand how to connect to your database.
Once you start getting comfortable with SchemaCrawler, and need to know more about how to do things, read the how-tos section.
Advanced Installation Steps
After you have worked through the examples, you can make a copy of this
_schemacrawler directory to any location on your hard-disk, and rename the directory to something appropriate. Then, put this directory on your
PATH. Once you open a command shell, you can run SchemaCrawler using
schemacrawler.sh on Unix).
SchemaCrawler Docker Image
Tweaking Your Installation
If you install SchemaCrawler to some other location, you can use David Guillot’s shell script to launch SchemaCrawler
Building From Source Code
To use SchemaCrawler in your development projects, or to build SchemaCrawler from the source code, read about building.
Additonal Installation Options
Additonal installation options are available from the SchemaCrawler ecosystem.