**:star: Star it :arrow_heading_up: if you love it!** [![Build with Dependencies](https://github.com/schemacrawler/SchemaCrawler/actions/workflows/build-with-dependencies.yml/badge.svg)](https://github.com/schemacrawler/SchemaCrawler/actions/workflows/build-with-dependencies.yml) [![Database Integration Tests](https://github.com/schemacrawler/SchemaCrawler/actions/workflows/database-integration-tests.yml/badge.svg?branch=main)](https://github.com/schemacrawler/SchemaCrawler/actions/workflows/database-integration-tests.yml) [![Codacy Coverage](https://app.codacy.com/project/badge/Coverage/84c0a068ce9349f2bcaa07b5977bd932)](https://app.codacy.com/gh/schemacrawler/SchemaCrawler/dashboard) [![Docker Pulls](https://img.shields.io/docker/pulls/schemacrawler/schemacrawler?color=FFDAB9)](https://hub.docker.com/r/schemacrawler/schemacrawler/) ![GitHub Repo stars](https://img.shields.io/github/stars/schemacrawler/schemacrawler?style=social) [![The Central Repository](https://img.shields.io/maven-central/v/us.fatehi/schemacrawler-commandline)](https://central.sonatype.com/search?q=us.fatehi.schemacrawler&sort=name) [![Scoop](https://img.shields.io/scoop/v/schemacrawler?color=0F80C1)](https://github.com/ScoopInstaller/Main/blob/master/bucket/schemacrawler.json) [![Chocolatey](https://img.shields.io/chocolatey/v/schemacrawler?color=0F80C1)]( https://community.chocolatey.org/packages/schemacrawler) # SchemaCrawler > [!NOTE] > * Please see the [SchemaCrawler website](https://www.schemacrawler.com/) for more details. > * Use the [SchemaCrawler AI MCP Server](https://github.com/schemacrawler/SchemaCrawler-AI-MCP-Server-Usage) to get deep insights into your database > * Explore the SchemaCrawler command-line with a [live online tutorial](https://killercoda.com/schemacrawler). ## About SchemaCrawler is a free database schema discovery and comprehension tool. SchemaCrawler has a good mix of useful features for data governance. You can [search for database schema objects](https://www.schemacrawler.com/schemacrawler-grep.html) using regular expressions, and output the schema and data in a readable text format. The output serves for database documentation, and is designed to be [diff-ed](https://en.wikipedia.org/wiki/Diff) against other database schemas. SchemaCrawler also generates [schema diagrams.](https://www.schemacrawler.com/diagramming.html) You can [execute scripts](https://www.schemacrawler.com/scripting.html) in any standard scripting language against your database. You can find potential schema design issues with [lint](https://www.schemacrawler.com/lint.html). SchemaCrawler can also generate structured database documentation in [Google OKF format](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/d44368c15e38e7c92481c5992e4f9b5b421a801d/okf/SPEC.md) using [SchemaCrawler Scribe](https://www.schemacrawler.com/scribe.html). SchemaCrawler supports almost any database that has a JDBC driver, but for convenience is [bundled with drivers](https://www.schemacrawler.com/database-support.html) for some commonly used RDBMS systems. SchemaCrawler works with any operating system that supports Java SE 17 or better. [SchemaCrawler is also a Java API](https://dev.to/sualeh/how-to-get-database-metadata-as-java-pojos-24li) that makes working with database metadata as easy as working with plain old Java objects. > The [SchemaCrawler-Core](https://github.com/schemacrawler/SchemaCrawler-Core) API and tools framework code is available as a separate GitHub project. ## Licensing SchemaCrawler is available under a number of [licenses](https://www.schemacrawler.com/license.html). ## Distributions and Downloads Explore the SchemaCrawler command-line with a [live online tutorial](https://killercoda.com/schemacrawler). SchemaCrawler is available in a number of formats, including a download with examples, source code examples, plugin starters, a Maven reporting plugin, Docker containers, operating system specific installers, and jars on The Central Repository. For a complete list, see [downloads and distributions](https://www.schemacrawler.com/downloads.html). ## Support Please get support on [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=schemacrawler), following the [Guidelines for Support](https://www.schemacrawler.com/consulting.html).