Skip to main content

Schema-to-diagram compiler for DBML and SQL — ASCII/Unicode ERDs from the command line

Project description

dbsketch

ASCII/Unicode ERD diagrams from DBML or SQL schemas — designed to look clean in READMEs, docstrings, and LLM prompts.

pip install dbsketch
dbsketch schema.sql
dbsketch schema.dbml

No Node.js installation required — a suitable runtime is downloaded automatically on first use.

Usage

dbsketch [options] <file>

Options:
  --no-types      Hide column types
  --no-columns    Show table names only
  --ascii         Use ASCII box-drawing (default: Unicode)
  --sql           Force SQL input mode (auto-detected from .sql extension)

Example

dbsketch schema.sql > docs/erd.txt

Web playground

Try it in the browser at dbsketch.dev.

More

Full documentation and source at github.com/jacobmpeters/dbsketch.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dbsketch-0.2.0-py3-none-any.whl (2.7 MB view details)

Uploaded Python 3

File details

Details for the file dbsketch-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: dbsketch-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dbsketch-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5fe3a950fe5ffd565ba6b47c2463ab9ad034761be23182d93121d21f47dd3e8c
MD5 00060d4f9f87275fb1d4ae2c2bb52c56
BLAKE2b-256 c6a6ac818e4bfe9964e01e86178a1311ce17cc06a98b6ef247bdccd2d88a0a95

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbsketch-0.2.0-py3-none-any.whl:

Publisher: publish-pypi.yml on jacobmpeters/dbsketch

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page