docs: add ADR-0003 sqlx::migrate catalog/data migrations#175
Open
yesyayen wants to merge 1 commit into
Open
Conversation
yesyayen
requested review from
LeeroyHannigan,
amrith,
c33howard,
jcshepherd and
pdf-amzn
as code owners
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
1 participant
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.
What
Adds ADR-0003 recording the decision to adopt
sqlx::migratefor PostgreSQLcatalog and data schema migrations.
Why
The homegrown migration runner tracked files by name with no checksum, so an
in-place edit of an already-shipped migration produced a silent schema drift that
broke
CreateTable. The ADR records the choice to replace it with sqlx's built-inmigration framework (which checksums each file and refuses to run when one changed
after it was applied).
Closes #
Testing done
N/A
Checklist
cargo test --workspace) — n/a, docs onlycargo fmt --check) — n/a, docs onlyADR / RFC:
docs/adr/0003-catalog-migration-mechanism.md(added in this PR)Breaking changes
N/A
By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache License 2.0 and I agree to the Developer Certificate of
Origin (DCO). See CONTRIBUTING.md for details.