Add hazard for new NOT NULL columns requiring backfill#254
Closed
catatsuy wants to merge 1 commit into
Closed
Conversation
Adding a new NOT NULL column usually needs a backfill. This change adds a hazard and shows a suggested online migration path (add nullable -> backfill -> set NOT NULL).
|
|
Contributor
|
Tweaked and merged in here. You should be marked as a contributor on the repo!.Thank you for your contribution! |
Contributor
Author
|
Thank you! @bplunkett-stripe |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a new hazard for schema diffs that add a new column as
NOT NULLwithout aDEFAULT.When this pattern is detected, the generated plan includes a clear warning and guidance for a safer online approach (add the column nullable, backfill data, then set
NOT NULLusing the existing online NOT NULL workflow).Motivation
ADD COLUMN ... NOT NULLwithout aDEFAULTis commonly unsafe for non-empty tables and can lead to failed migrations or unexpected blocking.pg-schema-diff already supports online
NOT NULLchanges for existing columns, but for new columns the tool cannot infer how to backfill data. This change helps operators notice the risk early and nudges them toward a staged migration.Testing
Added/updated tests to cover:
NOT NULLcolumn without aDEFAULTemits the new hazard and guidance.NOT NULLcolumn with a constantDEFAULTdoes not emit the hazard (or follows the intended behavior).Ran the test suite locally (
go test ./...).