cloudflare-docs icon indicating copy to clipboard operation
cloudflare-docs copied to clipboard

Hyperdrive example and tutorial for pgEdge

Open myzie opened this issue 1 year ago • 5 comments

Adds an examples and tutorials page describing how to use Cloudflare Hyperdrive with pgEdge Cloud.

As discussed with @elithrar in email. Thanks and let us know if any changes are required!

cc @susan-pgedge

Screenshot 2024-06-27 at 4 19 02 PM

myzie avatar Jun 27 '24 20:06 myzie

@thomasgauvin to review this week.

elithrar avatar Jun 27 '24 20:06 elithrar

Thanks for the contribution @myzie, gave it a first pass!

thomasgauvin avatar Jun 28 '24 03:06 thomasgauvin

@thomasgauvin @kodster28 - thanks for your feedback. I've incorporated most of the suggestions.

Regarding partials for reuse, I did make use of this via a new _npx-wrangler-hyperdrive.md for one section that is shared between the two main .md files. Reusing exact Typescript examples as you all mentioned is problematic in this case because the two situations query different tables. In the tutorial doc, a table that is created earlier in the tutorial is queried, which won't work in the example doc. This is a useful difference between the two documents IMHO, so I'd suggest we go with this if it works for you (LMK if not).

Regarding the tutorial's "Compare System Latency" section, I think having the example data here will be useful to some readers, but if you all would prefer to remove it we can do that.

Let me know if this looks good!

myzie avatar Jul 15 '24 20:07 myzie

@elithrar @kodster28 @thomasgauvin Hi all! I'm taking over from Curtis on the pgEdge side.

Is there any additional changes we need here to get this merged? We are eager to get this included.

mmols avatar Aug 14 '24 00:08 mmols

Created https://github.com/cloudflare/cloudflare-docs/pull/16481

This PR adds the pgEdge provider as per the standardized way to add a Hyperdrive example which reuses content across examples.

It omits the tutorial due to significant overlap and minimal new content (the docs is not the appropriate place for us to have vendor-specific benchmarks). This aligns pgEdge with other supported PgSQL database providers.

thomasgauvin avatar Aug 27 '24 17:08 thomasgauvin

pgEdge has been added to Hyperdrive docs! https://developers.cloudflare.com/hyperdrive/examples/pgedge/

Closing this PR as a result

thomasgauvin avatar Aug 29 '24 15:08 thomasgauvin