Skip to content

[Hyperdrive] Adding Deploy to Cloudflare buttons for Hyperdrive #22353

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

Draft
wants to merge 5 commits into
base: production
Choose a base branch
from
+37 −8
Draft

[Hyperdrive] Adding Deploy to Cloudflare buttons for Hyperdrive #22353

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
11b2f7c
Adding Deploy to Cloudflare buttons for Hyperdrive
Oxyjun May 12, 2025
4d37daa
Adding missing comma + using TypeScriptExample
Oxyjun May 13, 2025
43258b5
Merge commit 'b9af6e8ad8a2f05c08558c2d4fdddd85a1342ee4' into jun/hype…
Oxyjun Aug 7, 2025
7aaaec1
Fixing TypeScriptExample
Oxyjun Aug 7, 2025
4a6e2d9
Merge commit 'e701a2fb34f14efdbadc6d250c953dc85eaed7fc' into jun/hype…
Oxyjun Sep 9, 2025
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
31 changes: 28 additions & 3 deletions src/content/docs/hyperdrive/get-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,31 @@ Learn more about the [databases that Hyperdrive supports](/hyperdrive/reference/

:::

## Quick start

If you want to skip the steps and get started quickly, click on the button below.

<Tabs syncKey ="sqlType">
<TabItem label="PostgreSQL">

**PostgreSQL deployment**

[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/cloudflare/docs-examples/tree/hyperdrive-get-started/hyperdrive/hyperdrive-get-started-postgres)

</TabItem>
<TabItem label="MySQL">

**MySQL deployment**

[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/cloudflare/docs-examples/tree/hyperdrive-get-started/hyperdrive/hyperdrive-get-started-mysql)

</TabItem>
</Tabs>

This creates a repository in your GitHub account and deploys the application to Cloudflare Workers. Use this option if you are familiar with Cloudflare Workers, and wish to skip the step-by-step guidance.

You may wish to manually follow the steps if you are new to Cloudflare Workers.

## Prerequisites

Before you begin, ensure you have completed the following:
Expand Down Expand Up @@ -104,7 +129,7 @@ To create your first Hyperdrive, you will need:

Hyperdrive accepts the combination of these parameters in the common connection string format used by database drivers:

<Tabs>
<Tabs syncKey ="sqlType">
<TabItem label="PostgreSQL">
```txt

Expand Down Expand Up @@ -179,7 +204,7 @@ Once you have created a Hyperdrive configuration and bound it to your Worker, yo

### Install a database driver

<Tabs>
<Tabs syncKey ="sqlType">
<TabItem label="PostgreSQL">

To connect to your database, you will need a database driver which allows you to authenticate and query your database. For this tutorial, you will use [Postgres.js](https://github.com/porsager/postgres), one of the most widely used PostgreSQL drivers.
Expand All @@ -206,7 +231,7 @@ With the driver installed, you can now create a Worker script that queries your

### Write a Worker

<Tabs>
<Tabs syncKey ="sqlType">
<TabItem label="PostgreSQL">
After you have set up your database, you will run a SQL query from within your Worker.

Expand Down