# pingfangushi/screw

简洁好用的数据库表结构文档生成器

Repository: https://github.com/pingfangushi/screw
Canonical: https://ross.abutalabs.com/products/screw
Language: Java
License: LGPL-3.0
License Family: copyleft
Last push: 2023-04-13T06:37:44+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 2264, "days_push": 1238, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 3967, forks 728 (observed 2026-08-28T04:08:30.732800+00:00)

## What it is
screw is a Java library and Maven plugin that generates database table structure documentation from a live database connection. It supports multiple databases (MySQL, Oracle, PostgreSQL, SQL Server, etc.) and outputs documentation in HTML, Word, and Markdown formats with customizable templates.

## Use cases
- generate database table structure documentation
- export database schema to word document
- create html docs for mysql tables
- keep database design docs in sync with schema
- document postgresql table columns and comments
- generate markdown data dictionary from database

## When to choose
- you need up-to-date table structure docs without manual maintenance
- your database is one of the supported engines like MySQL, Oracle, or PostgreSQL
- you want documentation in HTML, Word, or Markdown from a Java/Maven project

## When to avoid
- you use an unsupported database like SQLite or DB2 (still in development)
- you need a non-Java tooling environment
- you need full schema migration or diff tooling rather than documentation

## Facets
- artifact type: library
- maturity: maintenance
- function: documentation, database, database-driver, templating
- domain: databases, documentation, developer-tools
- platform: jvm, cross-platform
- tags: database-documentation, table-structure, schema-documentation, word-export, markdown-export, html-export, maven-plugin

## Member repositories
- pingfangushi/screw (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:30.732800+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:24:24.302436+00:00, confidence not recorded.
  - readme: https://github.com/pingfangushi/screw (fetched 2026-08-28T04:08:30.732800+00:00, sha b53c1758c7a1)
- Data as of 2026-08-30T08:39:29.467469+00:00.