Skip to content

Resolving issue #1 (psql required for Generating tests) #2

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Resolving issue #1 (psql required for Generating tests) #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
020355d
Extended Documentation
haymang Mar 19, 2019
fcf8319
Merge pull request #1 from Shuttl-Tech/extending_documentation
haymang Mar 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,18 @@ when this project reaches a stable state.

## Generating test files

Setup Environment :-

- Install postgres,
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple small things:

  1. Up above there's a Setup section. I would just add a dependency on Postgres v10.6 (the version I'm coding against). You can add the instructions on how to install that particular version there.
  2. In this section, I would just mention in a sentence or two that the user should make sure he/she has the postgres server running so that psql is able to run against each test query. You can keep the instruction on how to start the server if you'd like. Thanks for that.

`brew install postgres` (OS : mac)
For OS other than mac, refer (http://postgresguide.com/setup/install.html)
- Launch/Start postgres Sql :
`pg_ctl -D /usr/local/var/postgres start`


As mentioned, tests have been generated from the official postgres repo
(https://github.com/postgres/postgres). To regenerate them, fetch the repository
at the desired version and run `./scripts/gen_psql_tests src/test/regress/sql /tmp/my_local_psql_tests/`
where `src/test/regress/sql` is a directory in the source postgres project.
at the desired version and run `path/to/antlr_postgres_repo/scripts/gen_psql_tests path/to/postgres_repo/src/test/regress/sql /tmp/my_local_psql_tests/`

## Parsing a specific query

Expand All @@ -66,4 +74,4 @@ that this can take a minute through the entire suite.





Copy link
Owner

@tshprecher tshprecher Apr 11, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: can you remove this space, and maybe a few more before it? That's mostly my mistake.