Add support for ignoring DDL statements using -- sqlc:ignore.

[sgielen]

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:

CREATE TABLE person_email (
  email TEXT NOT NULL
);

-- sqlc:ignore until https://github.com/sqlc-dev/sqlc/issues/3129 is resolved
INSERT INTO person_email (`email`)
  SELECT pe.email
  FROM person AS p
  JOIN JSON_TABLE(p.emails, '$[*]' COLUMNS(email TEXT PATH '$')) AS pe;
-- sqlc:ignore end

ALTER TABLE person_email ADD PRIMARY KEY (`email`);

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.

[sgielen]

@kyleconroy if you agree with this addition, then I would propose to add some documentation regarding this in https://docs.sqlc.dev/en/stable/howto/ddl.html. I can do that too within this PR, but wanted to await your thoughts first.

[sgielen]

@kyleconroy what do you think about this addition?

[sgielen]

@kyleconroy another bump - marking as non-draft in case that helps

[lisitsky]

Hi, @kyleconroy , @sgielen !

Thank you for the feature introduced!
I need the same functionality. How can I help with development? For example, with tests?

[lisitsky]

Hi, @kyleconroy , @sgielen !

Thank you for the feature introduced! I need the same functionality. How can I help with development? For example, with tests?

Hi! @sgielen I've updated the branch, added tests and rebased onto fresh master (it was relatively old), squashed into 1 commit. Could you please have a look? If you find tests useful, feel free to use them in your PR.
#3458

[sgielen]

Hi, @kyleconroy , @sgielen !
Thank you for the feature introduced! I need the same functionality. How can I help with development? For example, with tests?

Hi! @sgielen I've updated the branch, added tests and rebased onto fresh master (it was relatively old), squashed into 1 commit. Could you please have a look? If you find tests useful, feel free to use them in your PR. #3458

Excellent! Thank you for this. I never wrote additional tests or documentation, because I wanted to hear from the maintainers first, but they never responded to my pings (@kyleconroy trying again). I can close this PR in favor of yours? For context, perhaps your PR's description could link to this one and/or the issues mentioned in my description above?

[Nigel2392]

Any progress on this? Would be a neat addition.

[farhaven]

@kyleconroy another ping on this. It'd be really useful as a workaround for more complex migrations that sqlc can't parse but which aren't strictly relevant to the schema itself (such as re-creating stored procedures, modifying constraints, ...)

[sgielen]

Please review #3458, not this one, it is improved with regards to this one. I'll close this one as soon as that one is merged.