From 711f7ff1816863acc4b1e68edbce261527d403f9 Mon Sep 17 00:00:00 2001 From: Andrew Mason Date: Tue, 22 Aug 2023 12:32:45 -0400 Subject: [PATCH] add docs for `onlineddl retry` and `onlineddl cleanup` Signed-off-by: Andrew Mason --- .../vtctldclient_OnlineDDL/_index.md | 2 ++ .../vtctldclient_OnlineDDL_cleanup.md | 35 +++++++++++++++++++ .../vtctldclient_OnlineDDL_retry.md | 35 +++++++++++++++++++ 3 files changed, 72 insertions(+) create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.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 b472f01a4..0aeea2664 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,5 +22,7 @@ Operates on online DDL (schema migrations). ### SEE ALSO * [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient OnlineDDL cleanup](./vtctldclient_onlineddl_cleanup/) - Mark a given schema migration ready for artifact cleanup. +* [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_cleanup.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md new file mode 100644 index 000000000..665c2013b --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md @@ -0,0 +1,35 @@ +--- +title: OnlineDDL cleanup +series: vtctldclient +--- +## vtctldclient OnlineDDL cleanup + +Mark a given schema migration ready for artifact cleanup. + +``` +vtctldclient OnlineDDL cleanup +``` + +### Examples + +``` +OnlineDDL cleanup test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 +``` + +### Options + +``` + -h, --help help for cleanup +``` + +### 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_retry.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md new file mode 100644 index 000000000..369374cbc --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md @@ -0,0 +1,35 @@ +--- +title: OnlineDDL retry +series: vtctldclient +--- +## vtctldclient OnlineDDL retry + +Mark a given schema migration for retry. + +``` +vtctldclient OnlineDDL retry +``` + +### Examples + +``` +vtctl OnlineDDL retry test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 +``` + +### Options + +``` + -h, --help help for retry +``` + +### 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). +