results icon indicating copy to clipboard operation
results copied to clipboard
verified publisher icon djrobstep

Support Comments

Open amerryma opened this issue 7 months ago • 1 comments

I’d like to propose adding full comment support to dbdiff. Although several forks have experimented with this with Migra, the functionality has never landed in the main source. There are a few reasons to consider it: PostGraphile’s smart comments and pg_graphql both rely on Postgres comments to shape API behavior.

Postgres allows comments on nearly every kind of DDL object, so we’d aim to cover all relevant areas. Handling updates correctly would also mean accounting for cascading deletes and regenerations when objects change.

I’ve explored approaches to this before and am ready to open a PR once I finish the implementation. Before starting, I’d like to open the discussion and hear feedback on requirements, edge cases, or potential pitfalls. Thanks in advance for your thoughts.

amerryma avatar Sep 23 '25 21:09 amerryma

Keen for this. Any thoughts on if comments should be a separate "thing" that gets inspected or integrated into each existing entity like tables, views etc?

djrobstep avatar Sep 29 '25 10:09 djrobstep

Added column support.

djrobstep avatar Jan 28 '26 12:01 djrobstep

Hi @djrobstep I'm not seeing this work for me. You're saying you added support for comment diffing at the column level?

amerryma avatar Jan 28 '26 16:01 amerryma