Getting Started with SchemaCrawler

SchemaCrawler Installation

Pre-requisites for Installation

• Install the latest version of Java
• Optionally, install Graphviz if you want to create schema diagrams

Cross-platform Installation

There are multiple ways to download, install and use SchemaCrawler.

Getting Started

FAQs

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

Watch the video on How to explore a new database to understand the power of SchemaCrawler, and to give you some ideas of how to use it. Also read Explore Your Database Schema with SchemaCrawler, How to Get Database Metadata as Java POJOs and Lint Your Database Schema With GitHub Actions Workflows.

SchemaCrawler can generate diagrams of your database schema, and export them to other tools. Take a look at How to Generate dbdiagram.io Diagrams for Your Database and How to Generate Mermaid Diagrams for Your Database to see how you can continue to evolve your database design. If you want continuous ingtegration, see how you can Generate Database Diagrams With GitHub Actions Workflows.

And finally, here are some other quick getting started articles:

• How to Visualize Your MySql Database with One Command (and Nothing to Install)
• How to Visualize Your PostgreSQL Database with One Command (and Nothing to Install)
• How to Visualize Your SQLite Database with One Command (and Nothing to Install)
• Automatically Document Your Database in Markdown

Explore the Command-Line

Explore the SchemaCrawler command-line with a live online tutorial. The tutorial works from within any browser with no software or plugins needed.

If you want to experiment locally, look at the examples.

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

Configuration

SchemaCrawler offers rich configuration options. Read about them on the SchemaCrawler Configuration page.

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 schema diagrams. For more information, see information on the Docker image.

Building From Source Code

To use SchemaCrawler in your development projects, or to build SchemaCrawler from the source code, read about building.