feat: support OrmarConfig(comment=...) for table comments#1700
Merged
Conversation
Forwarded to the underlying sqlalchemy.Table and emitted by metadata.create_all() on PostgreSQL and MySQL (SQLite ignores it). copy() inherits the parent comment by default; pass comment=None explicitly to clear it. Closes #1240
Merging this PR will degrade performance by 10.02%
Performance Changes
Comparing |
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.
Adds
comment=toOrmarConfig(andOrmarConfig.copy()) so models can declare a SQLCOMMENT ON TABLEvalue. The comment is forwarded to the underlying SQLAlchemyTableand emitted bymetadata.create_all()on PostgreSQL and MySQL; SQLite ignores it.copy()inherits the parent's comment by default — passcomment=Noneto clear it or a new string to override, mirroring the existingschemasemantics.Closes #1240