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

docs: Add documentation on PostgreSQL extension #4124

Merged
merged 5 commits into from
Jan 25, 2024

Conversation

kaspermarstal
Copy link
Contributor

This PR adds documentation on the PL/PRQL PostgreSQL extension to

  • The "Integrations" section on the front page of the website
  • The "Integrations" section in the book

See also discussion in #725

Copy link
Member

@max-sixty max-sixty left a comment

Choose a reason for hiding this comment

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

Thanks!

Happy to merge.

One note — it's a shame that cargo pgrx doesn't make it easier to install, and requires cloning the repo. I would have hoped that cargo pgrx install could take a crates.io package.

It might be worth considering a one-command install option which would do many of these steps. It could probably be written in a build.rs such that cargo install plprql does much of it. There's always the curl ....sh | bash option otherwise...

Or maybe the convention is to use the postgres package repositories and investing there would be better?

web/book/src/project/integrations/postgresql.md Outdated Show resolved Hide resolved
Comment on lines 24 to 26
```
select prql('from rounds | filter match_id == 1, 'rounds_cursor');
```
Copy link
Member

Choose a reason for hiding this comment

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

If you're up for it, a fuller example of how to pull records from the cursor would be great!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, will add

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Expanded on the examples and added tests for the example code

Copy link
Member

@eitsupi eitsupi left a comment

Choose a reason for hiding this comment

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

Some minor suggestions.

web/book/src/project/integrations/postgresql.md Outdated Show resolved Hide resolved
web/book/src/project/integrations/postgresql.md Outdated Show resolved Hide resolved
web/book/src/project/integrations/postgresql.md Outdated Show resolved Hide resolved
web/book/src/project/integrations/postgresql.md Outdated Show resolved Hide resolved
web/book/src/project/integrations/postgresql.md Outdated Show resolved Hide resolved
web/book/src/project/integrations/postgresql.md Outdated Show resolved Hide resolved
web/book/src/project/integrations/postgresql.md Outdated Show resolved Hide resolved
kaspermarstal and others added 3 commits January 24, 2024 19:51
Co-authored-by: eitsupi <50911393+eitsupi@users.noreply.github.com>
@kaspermarstal
Copy link
Contributor Author

kaspermarstal commented Jan 25, 2024

One note — it's a shame that cargo pgrx doesn't make it easier to install, and requires cloning the repo. I would have hoped that cargo pgrx install could take a crates.io package.

It might be worth considering a one-command install option which would do many of these steps. It could probably be written in a build.rs such that cargo install plprql does much of it. There's always the curl ....sh | bash option otherwise...

That's an great idea. Will do that after I get .deb files packaged up. For now, I don't think we should block the PR on this.

Copy link
Member

Choose a reason for hiding this comment

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

Great summary! I think this is a really good balance between some preview without forking the whole plprql readme...

1 | 1001 | 1 | Player1 | 4 | 1
3 | 1001 | 2 | Player1 | 1 | 7
(2 rows)
```
Copy link
Member

Choose a reason for hiding this comment

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

Great example!

This is very cool indeed, I really like this way of doing it...

@max-sixty max-sixty merged commit cd95bc6 into PRQL:main Jan 25, 2024
36 of 37 checks passed
prql-bot pushed a commit that referenced this pull request Jan 26, 2024
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: eitsupi <50911393+eitsupi@users.noreply.github.com>
(cherry picked from commit cd95bc6)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants