Skip to content

Commit

Permalink
Docs: vtctldclient OnlineDDL cancel|complete|launch (#1572)
Browse files Browse the repository at this point in the history
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
  • Loading branch information
shlomi-noach authored Aug 30, 2023
1 parent a7bda26 commit b9b0d7a
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ Operates on online DDL (schema migrations).
### SEE ALSO

* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server.
* [vtctldclient OnlineDDL cancel](./vtctldclient_onlineddl_cancel/) - Cancel one or all pending migrations, terminating any actively running ones.
* [vtctldclient OnlineDDL cleanup](./vtctldclient_onlineddl_cleanup/) - Mark a given schema migration ready for artifact cleanup.
* [vtctldclient OnlineDDL complete](./vtctldclient_onlineddl_complete/) - Complete one or all migrations executed with `--postpone-completion`.
* [vtctldclient OnlineDDL launch](./vtctldclient_onlineddl_launch/) - Launch one or all migrations executed with `--postpone-launch`.
* [vtctldclient OnlineDDL retry](./vtctldclient_onlineddl_retry/) - Mark a given schema migration for retry.
* [vtctldclient OnlineDDL show](./vtctldclient_onlineddl_show/) - Display information about online DDL operations.

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).

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).

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).

0 comments on commit b9b0d7a

Please sign in to comment.