zhm/pg-query-parser

Wrong documentation?

joepie91 opened this issue · 2 comments

This repository seems to contain the documentation for pg-query-native rather than pg-query-parser - eg. deparse isn't documented. Is this intended?

zhm commented

Yes, you're correct. Sorry about that, I just haven't had time to get it documented. There are 3 scripts in the root of the repo which demonstrate the top-level API that I was using for verification.

https://github.com/zhm/pg-query-parser/blob/master/deparse
https://github.com/zhm/pg-query-parser/blob/master/parse
https://github.com/zhm/pg-query-parser/blob/master/verify

verify runs a complete parse + deparse + parse and verifies the symmetry of the parsing/deparsing.

zhm commented

Thanks for reporting this, the README is being updated on the v1 branch.

https://github.com/zhm/pg-query-parser/blob/v1/README.md