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

update pg native query sql definition #321

Merged
merged 2 commits into from
Mar 27, 2024
Merged

Conversation

soupi
Copy link

@soupi soupi commented Mar 27, 2024

Description

After hasura/ndc-postgres#372 we can now specify native queries as relative file paths outside of the configuration.json.

This PR adds documentation on how to do that.

Quick Links 🚀

https://cd595408.v3-docs-eny.pages.dev/connectors/postgresql/config#nativeQueries

🤖 DX: Assertion Tests

@soupi soupi added the hold-for-beta This PR should be held for the beta release on 29 February 2024. label Mar 27, 2024
@robertjdominguez
Copy link
Collaborator

Hey, @soupi 👋

Thanks for this PR! Since you changed docs files, our automated Action assigned Rob as your reviewer 🎉

Before Rob looks over the changes, we ask you to take care of a couple of items:

  • Make sure you've checked over our PR guide on the wiki. It ensures you've done your due diligence on the basics: spelling, heading casings, etc.
  • Rob will need a review from someone on your team to ensure your team-specific content is accurate. Once that's done, ping Rob on Slack, and he'll give a docs review 🔥
  • Additionally, please check this box to confirm your feature works as expected when using the documentation you've written. This is critical to ensuring our users have the information they need.

The docs team aims to get all PRs reviewed within 48 hours of your team doing a review in the form of a content pass. Let Rob know the level of urgency on Slack 👍

@robertjdominguez
Copy link
Collaborator

DX: Assertion Testing

✅ Diff

The addition of '$schema' provides a reference to the JSON schema which can be very useful for contributors looking to understand the format and validates the configurations. The expansion of the 'sql' field within 'nativeQueries' to include both 'inline' and 'file' is a significant improvement in usability, offering flexibility in how queries are defined and maintained. The examples provided are clear and well-documented.

✅ Integrated

The PR successfully improves the usability of the documentation by integrating the changes coherently with the original structure. The additional content regarding inline SQL versus file-based SQL definitions within 'nativeQueries' enriches the documentation's comprehensiveness. The updated link to the '[Configuration JSON Schema]' points to the static file within the same repository, ensuring consistency and reducing the dependency on external snapshots.

Copy link

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: d04f878
Status: ✅  Deploy successful!
Preview URL: https://cd595408.v3-docs-eny.pages.dev
Branch Preview URL: https://gil-nq-docs-update.v3-docs-eny.pages.dev

View logs

@robertjdominguez robertjdominguez enabled auto-merge (squash) March 27, 2024 12:56
Copy link
Collaborator

@robertjdominguez robertjdominguez left a comment

Choose a reason for hiding this comment

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

🎉

@robertjdominguez robertjdominguez merged commit a61e612 into main Mar 27, 2024
5 checks passed
@robertjdominguez robertjdominguez deleted the gil/nq-docs-update branch March 27, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hold-for-beta This PR should be held for the beta release on 29 February 2024.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants