-
Notifications
You must be signed in to change notification settings - Fork 203
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: vtctldclient OnlineDDL cancel|complete|launch (#1572)
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
- Loading branch information
1 parent
a7bda26
commit b9b0d7a
Showing
4 changed files
with
111 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
...e/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: OnlineDDL cancel | ||
series: vtctldclient | ||
--- | ||
## vtctldclient OnlineDDL cancel | ||
|
||
Cancel one or all pending migrations, terminating any actively running ones. | ||
|
||
``` | ||
vtctldclient OnlineDDL cancel <keyspace> <uuid|all> | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
OnlineDDL cancel test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 | ||
OnlineDDL cancel test_keyspace all | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for cancel | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--action_timeout duration timeout for the total command (default 1h0m0s) | ||
--server string server to use for connection (required) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vtctldclient OnlineDDL](../) - Operates on online DDL (schema migrations). | ||
|
36 changes: 36 additions & 0 deletions
36
...programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: OnlineDDL complete | ||
series: vtctldclient | ||
--- | ||
## vtctldclient OnlineDDL complete | ||
|
||
Complete one or all migrations executed with `--postpone-completion`. | ||
|
||
``` | ||
vtctldclient OnlineDDL complete <keyspace> <uuid|all> | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
OnlineDDL complete test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 | ||
OnlineDDL complete test_keyspace all | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for complete | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--action_timeout duration timeout for the total command (default 1h0m0s) | ||
--server string server to use for connection (required) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vtctldclient OnlineDDL](../) - Operates on online DDL (schema migrations). | ||
|
36 changes: 36 additions & 0 deletions
36
...e/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: OnlineDDL launch | ||
series: vtctldclient | ||
--- | ||
## vtctldclient OnlineDDL launch | ||
|
||
Launch one or all migrations executed with `--postpone-launch`. | ||
|
||
``` | ||
vtctldclient OnlineDDL launch <keyspace> <uuid|all> | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
OnlineDDL launch test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 | ||
OnlineDDL launch test_keyspace all | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for launch | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--action_timeout duration timeout for the total command (default 1h0m0s) | ||
--server string server to use for connection (required) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vtctldclient OnlineDDL](../) - Operates on online DDL (schema migrations). | ||
|