Skip to main content

HTML Reports

Added in v0.5. DeepDiff DB can generate a self-contained, interactive HTML report alongside the JSON and text outputs.

Generating a Report​

Pass --html to either diff or gen-pack:

# Diff with HTML report
deepdiffdb diff --config deepdiffdb.config.yaml --html

# Gen-pack with HTML report
deepdiffdb gen-pack --config deepdiffdb.config.yaml --html

The report is written to {output.dir}/report.html. It is a single self-contained file — no internet connection or external assets are needed to open it.

What the Report Contains​

The report is organised into four tabs:

Schema Diff Tab​

  • Lists every table with schema changes
  • For each table: expandable sections for column changes, index changes, and foreign key changes
  • Each change shows the production value and development value side-by-side
  • Tables with no schema changes are collapsed by default

Data Diff Tab​

  • Summary counts per table: rows added, rows removed, rows updated
  • Expandable per-table section showing the primary key of each changed row
  • Filtering controls to show only added / removed / updated rows

Conflicts Tab​

  • Lists all conflicts grouped by table
  • Each conflict shows the full row comparison with changed columns highlighted
  • Resolution status badge (auto-resolved, pending, resolved) when resolutions.json is present
  • Per-table resolution strategy shown when configured

SQL Migration Preview Tab​

  • The full content of migration_pack.sql rendered with SQL syntax highlighting
  • A copy-to-clipboard button
  • Statement count summary at the top

Exporting to PDF​

Use your browser's built-in print dialog (Cmd+P on macOS, Ctrl+P on Windows/Linux) and select Save as PDF. The report is styled with print-friendly CSS that hides the navigation and renders each tab section sequentially.

Notes​

  • The HTML file is self-contained and can be safely attached to a PR, emailed, or stored in an artifact registry.
  • For very large diffs (tens of thousands of changed rows), the Data Diff tab may render slowly in some browsers due to the volume of DOM nodes. Consider using the JSON output files for programmatic processing at that scale.