Wrangler commands (7)

Last updated Apr 21, 2026 The following Wrangler commands apply to Hyperdrive.

hyperdrive create

Create a Hyperdrive config

npmyarnpnpm

npx wrangler hyperdrive create <NAME>
yarn wrangler hyperdrive create <NAME>
pnpm wrangler hyperdrive create <NAME>
  • <NAME> string required

The name of the Hyperdrive config - --connection-string string The connection string for the database you want Hyperdrive to connect to - ex: protocol://user:password@host:port/database - --service-id string The Workers VPC Service ID of the origin database - --origin-host string alias: --host

The host of the origin database - --origin-port number alias: --port

The port number of the origin database - --origin-scheme string alias: --schemedefault: postgresql

The scheme used to connect to the origin database - --database string The name of the database within the origin database - --origin-user string alias: --user

The username used to connect to the origin database - --origin-password string alias: --password

The password used to connect to the origin database - --access-client-id string The Client ID of the Access token to use when connecting to the origin database - --access-client-secret string The Client Secret of the Access token to use when connecting to the origin database - --caching-disabled boolean Disables the caching of SQL responses - --max-age number Specifies max duration for which items should persist in the cache, cannot be set when caching is disabled - --swr number Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled - --ca-certificate-id string alias: --ca-certificate-uuid

Sets custom CA certificate when connecting to origin database. Must be valid UUID of already uploaded CA certificate. - --mtls-certificate-id string alias: --mtls-certificate-uuid

Sets custom mTLS client certificates when connecting to origin database. Must be valid UUID of already uploaded public/private key certificates. - --sslmode string Sets sslmode for connecting to database. For PostgreSQL: 'require, verify-ca, verify-full'. For MySQL: 'REQUIRED, VERIFY_CA, VERIFY_IDENTITY'. - --origin-connection-limit number The (soft) maximum number of connections that Hyperdrive may establish to the origin database - --binding string The binding name of this resource in your Worker - --update-config boolean Automatically update your config file with the newly added resource

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

hyperdrive delete

Delete a Hyperdrive config

npmyarnpnpm

npx wrangler hyperdrive delete <ID>
yarn wrangler hyperdrive delete <ID>
pnpm wrangler hyperdrive delete <ID>
  • <ID> string required

The ID of the Hyperdrive config

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

hyperdrive get

Get a Hyperdrive config

npmyarnpnpm

npx wrangler hyperdrive get <ID>
yarn wrangler hyperdrive get <ID>
pnpm wrangler hyperdrive get <ID>
  • <ID> string required

The ID of the Hyperdrive config

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

hyperdrive list

List Hyperdrive configs

npmyarnpnpm

npx wrangler hyperdrive list
yarn wrangler hyperdrive list
pnpm wrangler hyperdrive list

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

hyperdrive planetscale signature

Experimental

Generate a signed authorization for creating a Cloudflare-billed PlanetScale database

npmyarnpnpm

npx wrangler hyperdrive planetscale signature
yarn wrangler hyperdrive planetscale signature
pnpm wrangler hyperdrive planetscale signature

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

hyperdrive update

Update a Hyperdrive config

npmyarnpnpm

npx wrangler hyperdrive update <ID>
yarn wrangler hyperdrive update <ID>
pnpm wrangler hyperdrive update <ID>
  • <ID> string required

The ID of the Hyperdrive config - --name string Give your config a new name - --connection-string string The connection string for the database you want Hyperdrive to connect to - ex: protocol://user:password@host:port/database - --service-id string The Workers VPC Service ID of the origin database - --origin-host string alias: --host

The host of the origin database - --origin-port number alias: --port

The port number of the origin database - --origin-scheme string alias: --scheme

The scheme used to connect to the origin database - --database string The name of the database within the origin database - --origin-user string alias: --user

The username used to connect to the origin database - --origin-password string alias: --password

The password used to connect to the origin database - --access-client-id string The Client ID of the Access token to use when connecting to the origin database - --access-client-secret string The Client Secret of the Access token to use when connecting to the origin database - --caching-disabled boolean Disables the caching of SQL responses - --max-age number Specifies max duration for which items should persist in the cache, cannot be set when caching is disabled - --swr number Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled - --ca-certificate-id string alias: --ca-certificate-uuid

Sets custom CA certificate when connecting to origin database. Must be valid UUID of already uploaded CA certificate. - --mtls-certificate-id string alias: --mtls-certificate-uuid

Sets custom mTLS client certificates when connecting to origin database. Must be valid UUID of already uploaded public/private key certificates. - --sslmode string Sets sslmode for connecting to database. For PostgreSQL: 'require, verify-ca, verify-full'. For MySQL: 'REQUIRED, VERIFY_CA, VERIFY_IDENTITY'. - --origin-connection-limit number The (soft) maximum number of connections that Hyperdrive may establish to the origin database

<details>

<summary>

Global flags

</summary>

  • <code>--v</code><code>boolean</code> alias: --version

Show version number - <code>--cwd</code><code>string</code>Run as if Wrangler was started in the specified directory instead of the current working directory - <code>--config</code><code>string</code> alias: --c

Path to Wrangler configuration file - <code>--env</code><code>string</code> alias: --e

Environment to use for operations, and for selecting .env and .dev.vars files - <code>--env-file</code><code>string</code>Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files - <code>--install-skills</code><code>boolean</code> default: false

Install Cloudflare skills for detected AI coding agents before running the command - <code>--profile</code><code>string</code>Use a specific auth profile

</details>

Was this helpful?

YesNo

On this page

Wrangler commands (7) - 图1Docs

{"@context":"https://schema.org","@type":"WebPage","@id":"https://developers.cloudflare.com/hyperdrive/reference/wrangler-commands/#page","headline":"Wrangler commands","description":"Wrangler CLI commands for creating and managing Hyperdrive configurations.","url":"https://developers.cloudflare.com/hyperdrive/reference/wrangler-commands/","inLanguage":"en","image":"https://developers.cloudflare.com/hyperdrive/reference/wrangler-commands/og.png?v=3c560ce1e4f80fb0","dateModified":"2026-04-21","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}}


title: List Hyperdrives

Skip to content

API Reference

Hyperdrive

Configs

Copy Markdown

Open in ClaudeOpen in ChatGPTOpen in Cursor


Copy MarkdownView as Markdown