-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Making Hyperdrive and KV commands a partical render.
- Loading branch information
Showing
3 changed files
with
115 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
src/content/partials/workers/wrangler-commands/hyperdrive.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| --- | ||
| {} | ||
| --- | ||
|
|
||
| import { AnchorHeading } from "~/components"; | ||
|
|
||
| <AnchorHeading title="`create`" slug="hyperdrive-create" depth={3} /> | ||
|
|
||
| Create a new Hyperdrive configuration. | ||
|
|
||
| ```txt | ||
| wrangler hyperdrive create <CONFIG_NAME> [OPTIONS] | ||
| ``` | ||
|
|
||
| - `CONFIG_NAME` string required | ||
| - The name of the Hyperdrive configuration to create. | ||
| - `--connection-string` string optional | ||
| - The database connection string in the form `postgres://user:password@hostname:port/database`. | ||
| - `--host` string optional | ||
| - The hostname or IP address Hyperdrive should connect to. | ||
| - `--port` number optional | ||
| - The database port to connect to. | ||
| - `--scheme` string optional | ||
| - The scheme used to connect to the origin database - e.g. postgresql or postgres. | ||
| - `--database` string optional | ||
| - The database (name) to connect to. For example, Postgres or defaultdb. | ||
| - `--user` string optional | ||
| - The username used to authenticate to the database. | ||
| - `--password` string optional | ||
| - The password used to authenticate to the database. | ||
| - `--access-client-id` string optional | ||
| - 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`. | ||
| - `--access-client-secret` string optional | ||
| - 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`. | ||
| - `--caching-disabled` boolean optional | ||
| - Disables the caching of SQL responses. | ||
| - `--max-age` number optional | ||
| - Specifies max duration for which items should persist in the cache, cannot be set when caching is disabled. | ||
| - `--swr` number optional | ||
| - Stale While Revalidate - Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled. | ||
|
|
||
| <AnchorHeading title="`update`" slug="hyperdrive-update" depth={3} /> | ||
|
|
||
| Update an existing Hyperdrive configuration. | ||
|
|
||
| ```txt | ||
| wrangler hyperdrive update <ID> [OPTIONS] | ||
| ``` | ||
|
|
||
| - `ID` string required | ||
| - The ID of the Hyperdrive configuration to update. | ||
| - `--name` string optional | ||
| - The new name of the Hyperdrive configuration. | ||
| - `--origin-host` string optional | ||
| - The new database hostname or IP address Hyperdrive should connect to. | ||
| - `--origin-port` string optional | ||
| - The new database port to connect to. | ||
| - `--database` string optional | ||
| - The new database (name) to connect to. For example, Postgres or defaultdb. | ||
| - `--origin-user` string optional | ||
| - The new username used to authenticate to the database. | ||
| - `--origin-password` string optional | ||
| - The new password used to authenticate to the database. | ||
| - `--access-client-id` string optional | ||
| - 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` string optional | ||
| - 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` boolean optional | ||
| - Disables the caching of SQL responses. | ||
| - `--max-age` number optional | ||
| - Specifies max duration for which items should persist in the cache, cannot be set when caching is disabled. | ||
| - `--swr` number optional | ||
| - Stale While Revalidate - Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled. | ||
|
|
||
| <AnchorHeading title="`list`" slug="hyperdrive-list" depth={3} /> | ||
|
|
||
| List all Hyperdrive configurations. | ||
|
|
||
| ```txt | ||
| wrangler hyperdrive list | ||
| ``` | ||
|
|
||
| <AnchorHeading title="`delete`" slug="hyperdrive-delete" depth={3} /> | ||
|
|
||
| Delete an existing Hyperdrive configuration. | ||
|
|
||
| ```txt | ||
| wrangler hyperdrive delete <ID> | ||
| ``` | ||
|
|
||
| - `ID` string required | ||
| - The name of the Hyperdrive configuration to delete. | ||
|
|
||
| <AnchorHeading title="`get`" slug="hyperdrive-get" depth={3} /> | ||
|
|
||
| Get an existing Hyperdrive configuration. | ||
|
|
||
| ```txt | ||
| wrangler hyperdrive get <ID> | ||
| ``` | ||
|
|
||
| - `ID` string required | ||
| - The name of the Hyperdrive configuration to get. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters