Skip to content

Add local development section to Hyperdrive Pages Functions binding #17474

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

Closed
wants to merge 2 commits into from
Closed

Add local development section to Hyperdrive Pages Functions binding #17474

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9750cf2
Add local development section to Hyperdrive Pages Functions binding
mtlemilio Oct 10, 2024
4d7b792
Update src/content/docs/pages/functions/bindings.mdx
mtlemilio Oct 10, 2024
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
15 changes: 15 additions & 0 deletions src/content/docs/pages/functions/bindings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,6 +670,21 @@ export const onRequest: PagesFunction<Env> = async (context) => {

</TabItem> </Tabs>

### Interact with your Hyperdrive configs locally

You can interact with your Hyperdrive config bindings locally in one of two ways:

- Give you Hyperdrive binding a `localConnectionString` value in your Pages project's `wrangler.toml` file.
- **Recommended** Export the `WRANGLER_HYPERDRIVE_LOCAL_CONNECTION_STRING_<BINDING_NAME>` environment variable with the connection string to your database.

The local runtime will attempt to connect to your database using the connection string you provide with one of the two options above.

:::note

For more information about using Hyperdrive locally, see the [local development configuration guide](/hyperdrive/configuration/local-development/).

:::

## Analytics Engine

The [Analytics Engine](/analytics/analytics-engine/) binding enables you to write analytics within your Pages Function.
Expand Down
Loading