Repository navigation
docs: show the validate_schema upgrade hints - #248
Merged
Merged
Conversation
Benchmark gate✅ gate passed
Gated (fails the build): |
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.
Docs only, no issue. When
validate_schema()finds thatoutbox_pending_idx(changed in 0.15) oroutbox_leased_idx(new in 0.17) is missing, its error names the release and links to the matching upgrade migration. Only the Alembic guide's upgrade sections described this. The schema-validation page, where people land with the error in hand, didn't mention it.The page gains one section. It shows a real error message, copied from
_drift_entry_to_error's output for the 0.17 case, and a table mapping each index to its upgrade section. It also repeats the warning againstalembic revision --autogeneratefor these indexes, because autogenerate builds them withoutCONCURRENTLY.mkdocs build --strictpasses.