Skip to content
This repository was archived by the owner on Nov 12, 2024. It is now read-only.

Commit 8d6be7e

Browse files
1 parent 3566069 commit 8d6be7e

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

docs/reference/branch.md

+4
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ Some of the sub-commands have additional flags unique to the sub-command. This s
5656
| `--create` | Create a new branch if it does not exist | `switch` |
5757
| `--parent-branch <BRANCH_NAME>` | If a new branch is being created, use this to specify a parent branch. Default is `main`. | `switch` |
5858

59+
{% callout type="note" %}
60+
The `--region` flag can not be used with `--restore` when creating a branch. Branch backups will be restored to their original region.
61+
{% /callout %}
62+
5963
### Available flags
6064

6165
| **Flag** | **Description** |

docs/reference/connect.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ If there is only one branch available on the database, you can leave off `<BRANC
2929
| `--execute <COMMAND>` | Run the specified command after successfully connecting to the database. |
3030
| `--execute-env-url <ENV_VAR_NAME>` | Environment variable name that contains the exposed Database URL. Default is `DATABASE_URL`. |
3131
| `--execute-protocol <PROTOCOL>` | Protocol for the exposed URL (by default `DATABASE_URL`) value in execute. Default is `mysql2`. |
32-
| `--h` | Help with the `connect` command. |
32+
| `-h`, `--help` | Help with the `connect` command. |
3333
| `--host <HOST>` | Local host to bind and listen for connections. Default is `127.0.0.1`. |
3434
| `--org <ORG_NAME>` | The organization of the database you want to connect to. |
3535
| `--port <PORT>` | Local port to bind and listen for connections. Default is `3306`. |

docs/reference/database.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Some of the sub-commands have additional flags unique to the sub-command. This s
5656

5757
| **Flag** | **Description** |
5858
| --------------------------- | ------------------------------------------------------------ |
59-
| `--h` | Get help with the `database` command |
59+
| `-h`, `--help` | Get help with the `database` command |
6060
| `--org <ORGANIZATION_NAME>` | Specify the organization for the database you're acting upon |
6161

6262
### Global flags
@@ -72,6 +72,10 @@ Some of the sub-commands have additional flags unique to the sub-command. This s
7272
| `--service-token <TOKEN>` | The service token for authenticating. |
7373
| `--service-token-id <TOKEN_ID>` | The service token ID for authenticating. |
7474

75+
{% callout type="note" %}
76+
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).
77+
{% /callout %}
78+
7579
## Examples
7680

7781
### Create a new `scaler_pro` database

docs/reference/deploy-request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Some of the sub-commands have additional flags unique to the sub-command. This s
6363

6464
| Flag | Description |
6565
| --------------------------- | ------------------------------------------------------------------ |
66-
| `--h` | Get help with the `deploy-request` command |
66+
| `-h`, `--help` | Get help with the `deploy-request` command |
6767
| `--org <ORGANIZATION_NAME>` | Specify the organization for the deploy request you're acting upon |
6868

6969
### Global flags

0 commit comments

Comments
 (0)