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

Commit

Permalink
docs: upstream
Browse files Browse the repository at this point in the history 
planetscale/www@61772f4
  • Loading branch information
@planetscale-actions-bot
planetscale-actions-bot committed Oct 15, 2024
1 parent 5d52674 commit e153e4a
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
1 change: 0 additions & 1 deletion docs/reference/branch.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ pscale branch <SUB-COMMAND> <FLAG>
| `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 |
| `delete <DATABASE_NAME> <BRANCH_NAME>` | `--force` | Delete the specified branch from the a database |
| `diff <DATABASE_NAME> <BRANCH_NAME>` | `--web` | Show the diff of the specified branch against the parent branch. |
| `keyspaces <DATABASE_NAME> <BRANCH_NAME>` | | Show information for sharded keyspaces. |
| `list <DATABASE_NAME>` | `--web` | List all branches of a database |
| `promote <DATABASE_NAME> <BRANCH_NAME>` | | Promote a database branch to production |
| `refresh-schema <DATABASE_NAME> <BRANCH_NAME>` | | Refresh the schema for a database branch |
Expand Down
24 changes: 15 additions & 9 deletions docs/reference/keyspace.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,26 @@ pscale keyspace <SUB-COMMAND> <FLAG>

### Available sub-commands

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

> \* _Flag is required_
#### Sub-command flag descriptions

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

### Available flags

Expand Down

0 comments on commit e153e4a

Please sign in to comment.