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@8b53122
  • Loading branch information
@planetscale-actions-bot
planetscale-actions-bot committed Dec 12, 2023
1 parent 7c6c326 commit ce39c98
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions docs/reference/branch.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,21 @@ pscale branch <SUB-COMMAND> <FLAG>

### Available sub-commands

| **Sub-command** | **Sub-command flags** | **Description** |
| ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `create <DATABASE_NAME> <BRANCH_NAME>` | `--from <SOURCE_BRANCH>`, `--region <BRANCH_REGION>`, `--restore <BACKUP_NAME>`, `--seed-data` `--web`, `--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 |
| `safe-migrations enable <DATABASE_NAME> <BRANCH_NAME>` | | Enables safe migrations for a database branch |
| `safe-migrations disable <DATABASE_NAME> <BRANCH_NAME>` | | Disables safe migrations for a database branch |
| `schema <DATABASE_NAME> <BRANCH_NAME>` | `--web` | Show the schema of a branch |
| `show <DATABASE_NAME> <BRANCH_NAME>` | `--web` | Show a specific backup of a branch |
| `switch <BRANCH_NAME> --database <DATABASE_NAME>` | `--database <DATABASE_NAME>`\*, `--create`, `parent-branch <BRANCH_NAME>` | Switch to the specified branch |
| `vschema <DATABASE_NAME> <BRANCH_NAME>` | | Show the vschema for a sharded keyspace. Empty on non-sharded keyspaces. |
| **Sub-command** | **Sub-command flags** | **Description** |
| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `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 |
| `safe-migrations enable <DATABASE_NAME> <BRANCH_NAME>` | | Enables safe migrations for a database branch |
| `safe-migrations disable <DATABASE_NAME> <BRANCH_NAME>` | | Disables safe migrations for a database branch |
| `schema <DATABASE_NAME> <BRANCH_NAME>` | `--web` | Show the schema of a branch |
| `show <DATABASE_NAME> <BRANCH_NAME>` | `--web` | Show a specific backup of a branch |
| `switch <BRANCH_NAME> --database <DATABASE_NAME>` | `--database <DATABASE_NAME>`\*, `--create`, `parent-branch <BRANCH_NAME>` | Switch to the specified branch |
| `vschema <DATABASE_NAME> <BRANCH_NAME>` | | Show the vschema for a sharded keyspace. Empty on non-sharded keyspaces. |

> \* _Flag is required_
Expand Down

0 comments on commit ce39c98

Please sign in to comment.