docs: upstream

planetscale/www@6c6e101
planetscale · Jul 17, 2024 · 8d6be7e · 8d6be7e
1 parent 3566069
commit 8d6be7e
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/docs/reference/branch.md b/docs/reference/branch.md
@@ -56,6 +56,10 @@ Some of the sub-commands have additional flags unique to the sub-command. This s
 | `--create`                      | Create a new branch if it does not exist                                                              | `switch`                                   |
 | `--parent-branch <BRANCH_NAME>` | If a new branch is being created, use this to specify a parent branch. Default is `main`.             | `switch`                                   |
 
+{% callout type="note" %}
+The `--region` flag can not be used with `--restore` when creating a branch. Branch backups will be restored to their original region.
+{% /callout %}
+
 ### Available flags
 
 | **Flag**                    | **Description**                       |

diff --git a/docs/reference/connect.md b/docs/reference/connect.md
@@ -29,7 +29,7 @@ If there is only one branch available on the database, you can leave off `<BRANC
 | `--execute <COMMAND>`              | Run the specified command after successfully connecting to the database.                                                         |
 | `--execute-env-url <ENV_VAR_NAME>` | Environment variable name that contains the exposed Database URL. Default is `DATABASE_URL`.                                     |
 | `--execute-protocol <PROTOCOL>`    | Protocol for the exposed URL (by default `DATABASE_URL`) value in execute. Default is `mysql2`.                                  |
-| `--h`                              | Help with the `connect` command.                                                                                                 |
+| `-h`, `--help`                     | Help with the `connect` command.                                                                                                 |
 | `--host <HOST>`                    | Local host to bind and listen for connections. Default is `127.0.0.1`.                                                           |
 | `--org <ORG_NAME>`                 | The organization of the database you want to connect to.                                                                         |
 | `--port <PORT>`                    | Local port to bind and listen for connections. Default is `3306`.                                                                |

diff --git a/docs/reference/database.md b/docs/reference/database.md
@@ -56,7 +56,7 @@ Some of the sub-commands have additional flags unique to the sub-command. This s
 
 | **Flag**                    | **Description**                                              |
 | --------------------------- | ------------------------------------------------------------ |
-| `--h`                       | Get help with the `database` command                         |
+| `-h`, `--help`              | Get help with the `database` command                         |
 | `--org <ORGANIZATION_NAME>` | Specify the organization for the database you're acting upon |
 
 ### Global flags
@@ -72,6 +72,10 @@ Some of the sub-commands have additional flags unique to the sub-command. This s
 | `--service-token <TOKEN>`       | The service token for authenticating.                                                |
 | `--service-token-id <TOKEN_ID>` | The service token ID for authenticating.                                             |
 
+{% callout type="note" %}
+The `--format` flag does not apply to the database dump files created by the `dump` subcommand. All dumps are created in a SQL statement format compatible with [mydumper](https://github.com/mydumper/mydumper).
+{% /callout %}
+
 ## Examples
 
 ### Create a new `scaler_pro` database

diff --git a/docs/reference/deploy-request.md b/docs/reference/deploy-request.md
@@ -63,7 +63,7 @@ Some of the sub-commands have additional flags unique to the sub-command. This s
 
 | Flag                        | Description                                                        |
 | --------------------------- | ------------------------------------------------------------------ |
-| `--h`                       | Get help with the `deploy-request` command                         |
+| `-h`, `--help`              | Get help with the `deploy-request` command                         |
 | `--org <ORGANIZATION_NAME>` | Specify the organization for the deploy request you're acting upon |
 
 ### Global flags