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

Commit e153e4a

Browse files
planetscale-actions-botplanetscale-actions-bot
committed
docs: upstream
planetscale/www@61772f4
1 parent 5d52674 commit e153e4a

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

‎docs/reference/branch.md

-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ pscale branch <SUB-COMMAND> <FLAG>
2727
| `create <DATABASE_NAME> <BRANCH_NAME>` | `--from <SOURCE_BRANCH>`, `--region <BRANCH_REGION>`, `--restore <BACKUP_NAME>`, `--seed-data`, `--wait` | Create a new branch on the specified database |
2828
| `delete <DATABASE_NAME> <BRANCH_NAME>` | `--force` | Delete the specified branch from the a database |
2929
| `diff <DATABASE_NAME> <BRANCH_NAME>` | `--web` | Show the diff of the specified branch against the parent branch. |
30-
| `keyspaces <DATABASE_NAME> <BRANCH_NAME>` | | Show information for sharded keyspaces. |
3130
| `list <DATABASE_NAME>` | `--web` | List all branches of a database |
3231
| `promote <DATABASE_NAME> <BRANCH_NAME>` | | Promote a database branch to production |
3332
| `refresh-schema <DATABASE_NAME> <BRANCH_NAME>` | | Refresh the schema for a database branch |

‎docs/reference/keyspace.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,26 @@ pscale keyspace <SUB-COMMAND> <FLAG>
2222

2323
### Available sub-commands
2424

25-
| **Sub-command** | **Sub-command flags** | **Description** |
26-
| -------------------------------------------------------------- | --------------------- | ------------------------------------------------------------------------ |
27-
| `list <DATABASE_NAME> <BRANCH_NAME>` ` | | List all keyspaces within a database branch. |
28-
| `show <DATABASE_NAME> <BRANCH_NAME> <KEYSPACE_NAME>` | | Show a specific keyspace within a database branch. |
29-
| `vschema show <DATABASE_NAME> <BRANCH_NAME> <KEYSPACE_NAME>` | | Show the VSchema for a sharded keyspace. Empty on non-sharded keyspaces. |
30-
| `vschema update <DATABASE_NAME> <BRANCH_NAME> <KEYSPACE_NAME>` | `--vschema <FILE>`\* | Update a VSchema of a keyspace. |
25+
| **Sub-command** | **Sub-command flags** | **Description** |
26+
| -------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
27+
| `create <DATABASE_NAME> <BRANCH_NAME> <KEYSPACE_NAME>` | `--cluster-size <SIZE>`\*, `--additional-replicas <NUMBER>`, `--shards <NUMBER>` | Create a new keyspace within a database branch. |
28+
| `list <DATABASE_NAME> <BRANCH_NAME>` ` | | List all keyspaces within a database branch. |
29+
| `show <DATABASE_NAME> <BRANCH_NAME> <KEYSPACE_NAME>` | | Show a specific keyspace within a database branch. |
30+
| `resize <DATABASE_NAME <BRANCH_NAME> <KEYSPACE_NAME>` | `--cluster-size <SIZE>`, `--additional-replicas <NUMBER>` | Resize a keyspace. |
31+
| `resize cancel <DATABASE_NAME> <BRANCH_NAME> <KEYSPACE_NAME>` | | Cancel an ongoing keyspace resize. |
32+
| `resize status <DATABASE_NAME> <BRANCH_NAME> <KEYSPACE_NAME>` | | Show the status of the keyspace's last resize |
33+
| `vschema show <DATABASE_NAME> <BRANCH_NAME> <KEYSPACE_NAME>` | | Show the VSchema for a sharded keyspace. Empty on non-sharded keyspaces. |
34+
| `vschema update <DATABASE_NAME> <BRANCH_NAME> <KEYSPACE_NAME>` | `--vschema <FILE>`\* | Update a VSchema of a keyspace. |
3135

3236
> \* _Flag is required_
3337
3438
#### Sub-command flag descriptions
3539

36-
| **Sub-command flag** | **Description** | **Applicable sub-commands** |
37-
| -------------------- | ------------------------------------------------- | --------------------------- |
38-
| `--vschema <FILE>` | `<FILE>` is the path to the updated VSchema file. | `vschema update` |
40+
| **Sub-command flag** | **Description** | **Applicable sub-commands** |
41+
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------- |
42+
| `--additional-replicas <NUMBER>` | `<NUMBER>` is the number of replicas to add to the keyspace. By default, production branches include 2 replicas. | `create`, `resize` |
43+
| `--cluster-size <SIZE>` | `<SIZE>` is the size of the database cluster. | `create`, `resize` |
44+
| `--vschema <FILE>` | `<FILE>` is the path to the updated VSchema file. | `vschema update` |
3945

4046
### Available flags
4147

0 commit comments

Comments
 (0)