Wrangler commands

hyperdrive create

npm

npx wrangler hyperdrive create [NAME]

pnpm

pnpm wrangler hyperdrive create [NAME]

yarn

yarn 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

• --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 default: 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 CA sslmode for connecting to database.

• --origin-connection-limit number

  The (soft) maximum number of connections that Hyperdrive may establish to the origin database

hyperdrive update

npm

npx wrangler hyperdrive update [ID]

pnpm

pnpm wrangler hyperdrive update [ID]

yarn

yarn 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

• --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 CA sslmode for connecting to database.

• --origin-connection-limit number

  The (soft) maximum number of connections that Hyperdrive may establish to the origin database

hyperdrive list

npm

npx wrangler hyperdrive list

pnpm

pnpm wrangler hyperdrive list

yarn

yarn wrangler hyperdrive list

hyperdrive delete

npm

npx wrangler hyperdrive delete [ID]

pnpm

pnpm wrangler hyperdrive delete [ID]

yarn

yarn wrangler hyperdrive delete [ID]

• [ID] string required

  The ID of the Hyperdrive config

hyperdrive get

npm

npx wrangler hyperdrive get [ID]

pnpm

pnpm wrangler hyperdrive get [ID]

yarn

yarn wrangler hyperdrive get [ID]

• [ID] string required

  The ID of the Hyperdrive config