Add comment support #15

mookjp commented 4 years ago

WHAT

Add supports comments in DDL; only manual addition
- I know there's already issue to store the comments both in importing and exporting on #15, but it supports only manual addition of comments so that we can leave some comments and restored them on local if they are missed by other wrench operation, temporarily

WHY

Supporting comments on DDL is helpful, if it is only manual addition temporarily

googlebot commented 4 years ago

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

:memo: Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

mookjp commented 4 years ago

@googlebot I signed it!

googlebot commented 4 years ago

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

mookjp commented 4 years ago

I will think about the better approach like #15 and left this PR until then!

vvakame commented 3 years ago

@110y how about this PR? I need comment support 😉

halmai commented 3 years ago

I would also need to add comments to the scripts but unfortunately, a regexp-based solution is not reliable enough.

For example, if there is a command like this in the script:

INSERT INTO mytable (field) VALUES ('-- hello --')

it will become wrong:

INSERT INTO mytable (field) VALUES ('

illustration: https://play.golang.org/p/28ELu7ugA2D

I think a more careful parsing is needed.

I am happy to implement it but don't want to take it out from your hand either. Please, let me know if you have time for it, otherwise I will start working on it.

Another note: maybe not everybody is happy with a breaking change how wrench works. Therefore, I would be more conservative and would add a command-line option to turn ON the comment removal. The default behaviour should be the original behaviour.

110y commented 2 years ago

@mookjp @halmai

Sorry for tooooo late, but now wrench support writing comments to DDL/DML files by this PR: https://github.com/cloudspannerecosystem/wrench/pull/54, which parses DDL/DML and ignore comments by using spansql.

So, let me close this PR, thank you so much 🙏

cloudspannerecosystem / wrench