docs(installation): add missing pgrx initialization and database connection steps #514
Conversation
…ection steps This update includes the necessary steps to initialize pgrx, start the PostgreSQL database, and connect to it before enabling the pg_graphql extension. These steps address the gap in the installation process for new users, ensuring a smoother setup experience. Closes supabase#403
|
@SheteUC thanks for the PR. If you could fix the CI failure and tackle my review comments, I'd be happy to merge. |
docs/installation.md
Outdated
| Before enabling the extension in PostgreSQL, you need to initialize `pgrx`. Depending on your PostgreSQL installation, you might need to specify the path to `pg_config`. For example, on macOS with PostgreSQL installed via Homebrew: | ||
|
|
||
| ```bash | ||
| cargo pgrx init --pg14 "/opt/homebrew/bin/pg_config" |
There was a problem hiding this comment.
Can we do two things here:
- Use pg15 as it is a later version (also use pg15 below in other commands).
- Remove the path to pg_config as people might have a different path in their installation. Even better would be to simply use
cargo pgrx init --pg15and then add a note about explicitly mentioning pg_config only if it is not on path.
There was a problem hiding this comment.
For what it's worth, omitting the pg_config path for the cargo pgrx init --pg15 command gave me an error
Running cargo pgrx init --help seems to provide a clear explanation of the command and its usage!
(although I guess the latest would be pg16 now!)
docs/installation.md
Outdated
|
|
||
| ```psql | ||
| create extension pg_graphql; | ||
| ``` | ||
|
|
||
| These additional steps ensure that `pgrx` is properly initialized, and the database is started and connected before attempting to install and use the `pg_graphql` extension. |
There was a problem hiding this comment.
These additional steps
Which additional steps? The first time reader won't be able to see that some steps were added in this PR.
Maybe just remove this line as it comments on the documentation itself, which is unnecessary. Or at least, reword/reposition it.
What kind of change does this PR introduce?
doc update
What is the current behavior?
Installation Documentation missing some steps "cargo pgrx init ... start ... connect" #403
What is the new behavior?
This update includes the necessary steps to initialize pgrx, start the PostgreSQL database, and connect to it before enabling the pg_graphql extension. These steps address the gap in the installation process for new users, ensuring a smoother setup experience.
Additional context
Closes #403