From 535d0070e17ed04640eab112949935bcd1650038 Mon Sep 17 00:00:00 2001 From: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> Date: Wed, 30 Aug 2023 14:04:18 +0300 Subject: [PATCH] Docs: vtctldclient OnlineDDL cancel|complete|launch Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> --- .../vtctldclient_OnlineDDL/_index.md | 3 ++ .../vtctldclient_OnlineDDL_cancel.md | 36 +++++++++++++++++++ .../vtctldclient_OnlineDDL_complete.md | 36 +++++++++++++++++++ .../vtctldclient_OnlineDDL_launch.md | 36 +++++++++++++++++++ 4 files changed, 111 insertions(+) create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md index 0aeea2664..bc7f7e013 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md @@ -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. diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md new file mode 100644 index 000000000..bf3be78f1 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md @@ -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 +``` + +### 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). + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md new file mode 100644 index 000000000..4a447d75f --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md @@ -0,0 +1,36 @@ +--- +title: OnlineDDL complete +series: vtctldclient +--- +## vtctldclient OnlineDDL complete + +Complete one or all migrations executed with `--postpone-completion`. + +``` +vtctldclient OnlineDDL complete +``` + +### 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). + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md new file mode 100644 index 000000000..3529ec063 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md @@ -0,0 +1,36 @@ +--- +title: OnlineDDL launch +series: vtctldclient +--- +## vtctldclient OnlineDDL launch + +Launch one or all migrations executed with `--postpone-launch`. + +``` +vtctldclient OnlineDDL launch +``` + +### 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). +