add docs for onlineddl retry and onlineddl cleanup

Signed-off-by: Andrew Mason <andrew@planetscale.com>
vitessio · Aug 22, 2023 · 711f7ff · 711f7ff
1 parent ad2eadb
commit 711f7ff
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 0 deletions.
diff --git a/...t/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md b/...t/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/.../programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md b/.../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 <keyspace> <uuid>
+```
+
+### 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/...ce/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md b/...ce/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 <keyspace> <uuid>
+```
+
+### 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).
+