Add support for disabling type comments in the schema #1714
Conversation
This file contains 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
dmaicher
approved these changes
Oct 23, 2023
|
Should it be documented? |
|
Indeed. Please add docs and test, if it's easy enough |
stof
force-pushed
the
disable_type_comments
branch
2 times, most recently
from
1fb4262 to
e421b19
Compare
|
I added those. For the documentation, I'm adding that only in the configuration reference. I don't think it needs lots of documentation. |
stof
force-pushed
the
disable_type_comments
branch
from
e421b19 to
cae8e39
Compare
dmaicher
approved these changes
Oct 23, 2023
ostrolucky
approved these changes
Oct 23, 2023
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.
This adds a new
disable_type_commentsboolean setting in the DBAL configuration to expose the DBAL feature added in doctrine/dbal#6150DBAL 3.2 implemented the platform-aware schema comparison APIs which don't rely on the DC2Type comments on columns anymore and has deprecated the old schema comparison APIs. DBAL 4.0 removes type comments entirely (In 4.0, this setter would become a no-op in the Configuration class and it will be deprecated in 4.1).
For projects that use the new APIs (and doctrine/migrations uses them), the type comment is pure noise in the DB. And it would generate a DB migration when migrating to DBAL 4 to remove those comments (which are added for any
date*_immutablefields for instance). The new setting allows to perform the cleanup earlier than the DBAL 4 release (and avoiding to add new type comments for further schema changes until then).