https://github.com/schemacrawler/SchemaCrawler

Free database schema discovery and comprehension tool
https://github.com/schemacrawler/SchemaCrawler

database database-diagrams database-document database-documentation database-schema documentation driver e-r-diagram entity-relationship-diagram er-diagram java jdbc metadata-extraction reverse-engineering schema schemacrawler schemaspy

Last synced: about 1 month ago
JSON representation

Free database schema discovery and comprehension tool

• Host: GitHub
• URL: https://github.com/schemacrawler/SchemaCrawler
• Owner: schemacrawler
• License: other
• Created: 2015-07-18T03:54:56.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T01:47:48.000Z (6 months ago)
• Last Synced: 2024-10-29T15:04:35.313Z (6 months ago)
• Topics: database, database-diagrams, database-document, database-documentation, database-schema, documentation, driver, e-r-diagram, entity-relationship-diagram, er-diagram, java, jdbc, metadata-extraction, reverse-engineering, schema, schemacrawler, schemaspy
• Language: Java
• Homepage: http://www.schemacrawler.com/
• Size: 78.7 MB
• Stars: 1,618
• Watchers: 48
• Forks: 200
• Open Issues: 6
• Metadata Files:
  • Readme: .github/README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• my-awesome-github-stars - schemacrawler/SchemaCrawler - Free database schema discovery and comprehension tool (Java)
• jimsghstars - schemacrawler/SchemaCrawler - Free database schema discovery and comprehension tool (Java)

README

        

[![Quick Build](https://github.com/schemacrawler/SchemaCrawler/workflows/Quick%20Build/badge.svg)](https://github.com/schemacrawler/SchemaCrawler/actions?query=workflow%3A%22Quick+Build%22)

[![Integration Tests](https://github.com/schemacrawler/SchemaCrawler/workflows/Integration%20Tests/badge.svg)](https://github.com/schemacrawler/SchemaCrawler/actions?query=workflow%3A%22Integration+Tests%22)

[![Codacy Grade](https://app.codacy.com/project/badge/Grade/84c0a068ce9349f2bcaa07b5977bd932)](https://app.codacy.com/gh/schemacrawler/SchemaCrawler/dashboard)

[![Codacy Coverage](https://img.shields.io/codacy/coverage/84c0a068ce9349f2bcaa07b5977bd932)](https://app.codacy.com/gh/schemacrawler/SchemaCrawler/dashboard)

[![Main distribution](https://img.shields.io/github/downloads/schemacrawler/schemacrawler/total?color=FFDAB9)](https://github.com/schemacrawler/SchemaCrawler/releases/latest)

[![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)](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.

> * 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 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 8 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.

## 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).