Add support for ignoring DDL statements using -- sqlc:ignore
.
#3130
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.
NOTE: This PR is in a draft state, because it still requires (at the very least) documentation updates.
This PR adds support for commenting out parts of the schema. This is most useful in the case where the schema is defined by migrations, and such migrations contain queries that are not yet supported by sqlc. See for example #3129, #1756.
By wrapping such unsupported queries in
sqlc:ignore
comments, they are ignored and the rest of the schema can be parsed appropriately.Example usage in a migration file:
See #3129 for a full use-case.
Since the lines are actually cleared, instead of removed, errors on queries below the
sqlc:ignore end
marker are still shown with the correct line number.