Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation on MySQL Regex Capabilities #214

Open
alexstandiford opened this issue Nov 26, 2022 · 1 comment
Open

Documentation on MySQL Regex Capabilities #214

alexstandiford opened this issue Nov 26, 2022 · 1 comment

Comments

@alexstandiford
Copy link

alexstandiford commented Nov 26, 2022

Hello there! Thanks for making this, and if you're reading this I appreciate your contributions!

I am implementing this project in a CSV importer utility here, and I managed to figure out how to use the MySQL-like syntax that is referenced here.

However, I noticed that details of this capability isn't documented anywhere, and it took me a bit of effort to parse the regex to understand exactly what format was expected. I was using id=1 for a while before I realized it should be id = 1.

I think it would be good to add a section to the documentation that details how this works, ideally with some examples on how to use each one. I'd be happy to write this up, but I'm hoping someone with some context can help me along. I see there are many operations available, but I'm not entirely sure exactly how to use each one.

@gogowitsch
Copy link
Member

Thanks for your feedback. I am sorry you lost time.

I think a heading under the “Example Usage“ section of the README.md is a good place to put your gotcha about missing spaces. Also, living examples can go into the “examples“ sub directory. Have a look at https://github.com/parsecsv/parsecsv-for-php/blob/main/examples/conditions.php, maybe you can extend that one. Pull requests are welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants