diff --git a/src/content/partials/workers/wrangler-commands/hyperdrive.mdx b/src/content/partials/workers/wrangler-commands/hyperdrive.mdx index 3ff36ac76e7d086..2dd940a90b485c7 100644 --- a/src/content/partials/workers/wrangler-commands/hyperdrive.mdx +++ b/src/content/partials/workers/wrangler-commands/hyperdrive.mdx @@ -2,132 +2,14 @@ {} --- -import { AnchorHeading, Type, MetaInfo, Render } from "~/components"; +import { AnchorHeading, Type, MetaInfo, Render, WranglerCommand } from "~/components"; - + -Create a new Hyperdrive configuration. + -```txt -wrangler hyperdrive create [OPTIONS] -``` + -- `CONFIG_NAME` - - The name of the Hyperdrive configuration to create. -- `--connection-string` - - The database connection string in the form `postgres://user:password@hostname:port/database`. -- `--origin-host` - - The hostname or IP address Hyperdrive should connect to. -- `--origin-port` - - The database port to connect to. -- `--origin-scheme` - - The scheme used to connect to the origin database, for example, postgresql or postgres. -- `--database` - - The database (name) to connect to. For example, Postgres or defaultdb. -- `--origin-user` - - The username used to authenticate to the database. -- `--origin-password` - - The password used to authenticate to the database. -- `--access-client-id` - - The Client ID of the Access token to use when connecting to the origin database, must be set with a Client Access Secret. Mutually exclusive with `origin-port`. -- `--access-client-secret` - - The Client Secret of the Access token to use when connecting to the origin database, must be set with a Client Access ID. Mutually exclusive with `origin-port`. -- `--caching-disabled` - - Disables the caching of SQL responses. -- `--max-age` - - Specifies max duration for which items should persist in the cache, cannot be set when caching is disabled. -- `--swr` - - Stale While Revalidate - Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled. -- `--ca-certificate-id` - - Sets custom CA certificate when connecting to origin database. -- `--mtls-certificate-id` - - Sets custom mTLS client certificates when connecting to origin database. -- `--sslmode` - - Sets SSL mode for CA verification. Must be `require` | `verify-ca` | `verify-full`. -- `--origin-connection-limit` - - The (soft) maximum number of connections that Hyperdrive may establish to the origin database. + - - - - -Update an existing Hyperdrive configuration. - -```txt -wrangler hyperdrive update [OPTIONS] -``` - -- `ID` - - The ID of the Hyperdrive configuration to update. -- `--name` - - The new name of the Hyperdrive configuration. -- `--connection-string` - - The database connection string in the form `postgres://user:password@hostname:port/database`. -- `--origin-host` - - The new database hostname or IP address Hyperdrive should connect to. -- `--origin-port` - - The new database port to connect to. -- `--origin-scheme` - - The scheme used to connect to the origin database, for example, postgresql or postgres. -- `--database` - - The new database (name) to connect to. For example, Postgres or defaultdb. -- `--origin-user` - - The new username used to authenticate to the database. -- `--origin-password` - - The new password used to authenticate to the database. -- `--access-client-id` - - The Client ID of the Access token to use when connecting to the origin database, must be set with a Client Access Secret. Mutually exclusive with `origin-port`. -- `--access-client-secret` - - The Client Secret of the Access token to use when connecting to the origin database, must be set with a Client Access ID. Mutually exclusive with `origin-port`. -- `--caching-disabled` - - Disables the caching of SQL responses. -- `--max-age` - - Specifies max duration for which items should persist in the cache, cannot be set when caching is disabled. -- `--swr` - - Stale While Revalidate - Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled. -- `--ca-certificate-id` - - Sets custom CA certificate when connecting to origin database. -- `--mtls-certificate-id` - - Sets custom mTLS client certificates when connecting to origin database. -- `--sslmode` - - Sets SSL mode for CA verification. Must be `require` | `verify-ca` | `verify-full`. -- `--origin-connection-limit` - - The (soft) maximum number of connections that Hyperdrive may establish to the origin database. - - - - - -List all Hyperdrive configurations. - -```txt -wrangler hyperdrive list -``` - - - - - -Delete an existing Hyperdrive configuration. - -```txt -wrangler hyperdrive delete -``` - -- `ID` - - The name of the Hyperdrive configuration to delete. - - - - - -Get an existing Hyperdrive configuration. - -```txt -wrangler hyperdrive get -``` - -- `ID` - - The name of the Hyperdrive configuration to get. - - + \ No newline at end of file