# schemaspy/schemaspy

Database documentation built easy

Repository: https://github.com/schemaspy/schemaspy
Canonical: https://ross.abutalabs.com/products/schemaspy
Homepage: http://schemaspy.org
Language: HTML
License: LGPL-3.0
License Family: copyleft
Topics: schemaspy, java, documentation, database, database-schemas, database-diagrams, schema, database-documentation, entity-relationship-diagram, er-diagram, reverse-engineering, data-dictionary
Last push: 2026-03-05T20:31:40+00:00

## Health v2 (maintenance only)
Score: 57/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 70, release rhythm 16, longevity 100
- inputs: {"age_days": 3691, "days_push": 181, "days_rel": 347, "gap_med": null, "n_releases_24m": 1}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 3710, forks 358 (observed 2026-08-28T04:08:15.188331+00:00)

## What it is
SchemaSpy is a Java-based database metadata analyzer that generates HTML documentation of relational database schemas, including entity-relationship diagrams and data dictionaries. It runs as a standalone JAR or Docker image against a live database via JDBC drivers.

## Use cases
- generate database documentation from an existing schema
- visualize entity-relationship diagrams for a database
- create a data dictionary for tables and columns
- document a PostgreSQL or SQL Server schema as HTML
- reverse-engineer a legacy database schema
- share database schema docs with my team

## When to choose
- you need automatically generated, navigable HTML docs for a relational database
- you want ER diagrams without drawing them manually
- you prefer a standalone tool or Docker image with no GUI setup
- you want documentation regenerated continuously as the schema evolves

## When to avoid
- you need documentation for non-relational databases like MongoDB
- you want a GUI-based schema design tool rather than a report generator
- your database is not reachable via JDBC
- you need editable, hand-written documentation rather than generated output

## Facets
- artifact type: cli-tool
- maturity: active
- function: documentation, database, developer-tools
- domain: databases, documentation, developer-tools
- platform: cli, cross-platform, jvm
- tags: er-diagrams, schema-analysis, html-reports, jdbc, data-dictionary, docker

## Member repositories
- schemaspy/schemaspy (main) score 57

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:15.188331+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:30:55.944927+00:00, confidence not recorded.
  - readme: https://github.com/schemaspy/schemaspy (fetched 2026-08-28T04:08:15.188331+00:00, sha 22df2a395914)
  - homepage: http://schemaspy.org (fetched 2026-08-29T09:24:25.245718+00:00, sha 088ef5fa7401)
- Data as of 2026-08-30T08:39:29.467469+00:00.