Skip to content

Document pg_dump style and fix stale "how it works" intro#10

Merged
gmr merged 1 commit into
mainfrom
docs/document-pg-dump-style
Jun 16, 2026
Merged

Document pg_dump style and fix stale "how it works" intro#10
gmr merged 1 commit into
mainfrom
docs/document-pg-dump-style

Conversation

@gmr

@gmr gmr commented Jun 16, 2026

Copy link
Copy Markdown
Owner
  • Add pg_dump to the styles table and a dedicated section with a real ruleutils.c deparser example, noting pgdump/postgres aliases
  • Add a --style pg_dump usage example piping pg_dump output through pgfmt
  • Rewrite the intro: pgfmt is a CLI wrapper around the Rust libpgfmt crate (parsing via tree-sitter-postgres), replacing the stale Python-era description and dead GitHub link

Summary by CodeRabbit

  • Documentation
    • Updated README with clearer description of pgfmt as a PostgreSQL SQL formatter
    • Added new pg_dump style option for formatting PostgreSQL dump output
    • Included example usage for round-tripping pg_dump --schema-only output with pgfmt

- Add pg_dump to the styles table and a dedicated section with a real
  ruleutils.c deparser example, noting pgdump/postgres aliases
- Add a --style pg_dump usage example piping pg_dump output through pgfmt
- Rewrite the intro: pgfmt is a CLI wrapper around the Rust libpgfmt
  crate (parsing via tree-sitter-postgres), replacing the stale
  Python-era description and dead GitHub link

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@gmr gmr merged commit 05548ae into main Jun 16, 2026
@gmr gmr deleted the docs/document-pg-dump-style branch June 16, 2026 18:36
@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 30d680ef-9175-4bc3-a7c1-2b8ad01e4fe5

📥 Commits

Reviewing files that changed from the base of the PR and between 4c5b805 and e152aad.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README is updated to reframe pgfmt as a wrapper around libpgfmt, add a pg_dump style entry to the styles table, include a usage example for pg_dump --schema-only round-tripping, and add a dedicated ### pg_dump section with formatting rules and a SQL example.

Changes

pg_dump style documentation

Layer / File(s) Summary
README: pg_dump style entry and reference section
README.md
Intro rewritten to describe pgfmt as a libpgfmt wrapper parsing via tree-sitter-postgres; usage example added for pg_dump --schema-only round-tripping; pg_dump row added to the styles table; ### pg_dump section added documenting ruleutils.c deparser mimicry, uppercase keywords, byte-identical round-trip requirement, accepted aliases, and an SQL example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hoppy news from the warren today,
pg_dump style has joined the fray!
Round-trip your schemas, byte by byte,
ruleutils.c keeps it right.
One README patch, the docs now gleam — thump thump! 🥕


Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant