Skip to content

Commit bc44df6

Browse files
authored
[Hyperdrive] Update wrangler command documentation for hyperdrive (#17840)
1 parent 4737d9c commit bc44df6

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

src/content/partials/workers/wrangler-commands/hyperdrive.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,22 @@ wrangler hyperdrive create <CONFIG_NAME> [OPTIONS]
1616
- The name of the Hyperdrive configuration to create.
1717
- `--connection-string` <Type text="string" /> <MetaInfo text="optional" />
1818
- The database connection string in the form `postgres://user:password@hostname:port/database`.
19-
- `--host` <Type text="string" /> <MetaInfo text="optional" />
19+
- `--origin-host` <Type text="string" /> <MetaInfo text="optional" />
2020
- The hostname or IP address Hyperdrive should connect to.
21-
- `--port` <Type text="number" /> <MetaInfo text="optional" />
21+
- `--origin-port` <Type text="number" /> <MetaInfo text="optional" />
2222
- The database port to connect to.
23-
- `--scheme` <Type text="string" /> <MetaInfo text="optional" />
23+
- `--origin-scheme` <Type text="string" /> <MetaInfo text="optional" />
2424
- The scheme used to connect to the origin database, for example, postgresql or postgres.
2525
- `--database` <Type text="string" /> <MetaInfo text="optional" />
2626
- The database (name) to connect to. For example, Postgres or defaultdb.
27-
- `--user` <Type text="string" /> <MetaInfo text="optional" />
27+
- `--origin-user` <Type text="string" /> <MetaInfo text="optional" />
2828
- The username used to authenticate to the database.
29-
- `--password` <Type text="string" /> <MetaInfo text="optional" />
29+
- `--origin-password` <Type text="string" /> <MetaInfo text="optional" />
3030
- The password used to authenticate to the database.
3131
- `--access-client-id` <Type text="string" /> <MetaInfo text="optional" />
32-
- 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 `port`.
32+
- 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`.
3333
- `--access-client-secret` <Type text="string" /> <MetaInfo text="optional" />
34-
- 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 `port`.
34+
- 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`.
3535
- `--caching-disabled` <Type text="boolean" /> <MetaInfo text="optional" />
3636
- Disables the caching of SQL responses.
3737
- `--max-age` <Type text="number" /> <MetaInfo text="optional" />
@@ -51,10 +51,14 @@ wrangler hyperdrive update <ID> [OPTIONS]
5151
- The ID of the Hyperdrive configuration to update.
5252
- `--name` <Type text="string" /> <MetaInfo text="optional" />
5353
- The new name of the Hyperdrive configuration.
54+
- `--connection-string` <Type text="string" /> <MetaInfo text="optional" />
55+
- The database connection string in the form `postgres://user:password@hostname:port/database`.
5456
- `--origin-host` <Type text="string" /> <MetaInfo text="optional" />
5557
- The new database hostname or IP address Hyperdrive should connect to.
5658
- `--origin-port` <Type text="string" /> <MetaInfo text="optional" />
5759
- The new database port to connect to.
60+
- `--origin-scheme` <Type text="string" /> <MetaInfo text="optional" />
61+
- The scheme used to connect to the origin database, for example, postgresql or postgres.
5862
- `--database` <Type text="string" /> <MetaInfo text="optional" />
5963
- The new database (name) to connect to. For example, Postgres or defaultdb.
6064
- `--origin-user` <Type text="string" /> <MetaInfo text="optional" />

0 commit comments

Comments
 (0)