SchemaCrawler Installation

Pre-requisites for Installation

Cross-platform Installation

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. You can move this folder to any location on your system.

Getting Started

FAQs

Before downloading SchemaCrawler, be sure to read the FAQs and take a look at the resources.

Also read the Scribe Tools Read The Docs guide.

Examples

The first thing to try is the SchemaCrawler examples.

Several examples on how to use SchemaCrawler on the command-line, with Apache ant or with Apache Maven, as an API, how to script your database using JavaScript, Groovy, Ruby or Python, how to create database diagrams with Graphviz, how to integrate with the Spring Framework, and how to use the Apache Velocity templating integration are provided with the SchemaCrawler distribution with examples download.

Command-line Help

SchemaCrawler provides detailed command-line help. Simply run schemacrawler.cmd (or 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.

How-tos

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

Advanced Topics

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.cmd (or schemacrawler.sh on Unix).

SchemaCrawler Docker Image

You can use the official SchemaCrawler Docker image from Docker Hub to reduce some of your installation steps. It comes with Graphviz pre-installed, so you can generate diagrams.

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.