Skip to content

docs: describe how pg_dump schema snapshots load - #70

Merged
omer-cengel merged 1 commit into
masterfrom
chore/document-pg-dump-schema-snapshot-loading
Oct 10, 2026
Merged

omer-cengel merged 1 commit into
masterfrom
chore/document-pg-dump-schema-snapshot-loading

Conversation

@omer-cengel

Copy link
Copy Markdown
Member

Summary

Documents that a pg_dump --schema-only file can be configured directly as a schema snapshot, so services that keep their schema outside SQL migrations (for example a Liquibase changelog or a JPA-generated schema) can use their dump as sqlcj's schema input.

Changes

  • Explain that a dump loads unchanged as one schema file, with nothing to edit, remove, or reorder.
  • List the dump content sqlcj ignores rather than rejects: psql meta-commands including \restrict/\unrestrict, the SET preamble and set_config call, the identity form pg_dump writes, constraints, indexes, ownership, grants, policies, comments, extensions, domains, composite types, functions, triggers, views, materialized views, and every schema other than public.
  • Describe how partitions written as CREATE TABLE plus ATTACH PARTITION are modeled, and when a dump and its migration history can differ.
  • List the integration tests that prove a migration history, a hand-written snapshot, and a dump generate identical output.

Scope and non-goals

Documentation only; no change to parsing, analysis, or generated code.

@omer-cengel
omer-cengel merged commit 16a2bca into master Oct 10, 2026
7 checks passed
@omer-cengel
omer-cengel deleted the chore/document-pg-dump-schema-snapshot-loading branch October 10, 2026 22:40
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