diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/_index.md b/content/en/docs/18.0/reference/programs/vtctldclient/_index.md index 1f283e23b..d0d82c07c 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/_index.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/_index.md @@ -67,6 +67,7 @@ vtctldclient [flags] * [vtctldclient GetWorkflows](./vtctldclient_getworkflows/) - Gets all vreplication workflows (Reshard, MoveTables, etc) in the given keyspace. * [vtctldclient LegacyVtctlCommand](./vtctldclient_legacyvtctlcommand/) - Invoke a legacy vtctlclient command. Flag parsing is best effort. * [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). * [vtctldclient PingTablet](./vtctldclient_pingtablet/) - Checks that the specified tablet is awake and responding to RPCs. This command can be blocked by other in-flight operations. * [vtctldclient PlannedReparentShard](./vtctldclient_plannedreparentshard/) - Reparents the shard to a new primary, or away from an old primary. Both the old and new primaries must be up and running. * [vtctldclient RebuildKeyspaceGraph](./vtctldclient_rebuildkeyspacegraph/) - Rebuilds the serving data for the keyspace(s). This command may trigger an update to all connected clients. 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 new file mode 100644 index 000000000..b472f01a4 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md @@ -0,0 +1,26 @@ +--- +title: OnlineDDL +series: vtctldclient +--- +## vtctldclient OnlineDDL + +Operates on online DDL (schema migrations). + +### Options + +``` + -h, --help help for OnlineDDL +``` + +### 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](../) - Executes a cluster management command on the remote vtctld server. +* [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_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md new file mode 100644 index 000000000..b8f5f784a --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md @@ -0,0 +1,46 @@ +--- +title: OnlineDDL show +series: vtctldclient +--- +## vtctldclient OnlineDDL show + +Display information about online DDL operations. + +``` +vtctldclient OnlineDDL show +``` + +### Examples + +``` +OnlineDDL show test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 +OnlineDDL show test_keyspace all +OnlineDDL show --order descending test_keyspace all +OnlineDDL show --limit 10 test_keyspace all +OnlineDDL show --skip 5 --limit 10 test_keyspace all +OnlineDDL show test_keyspace running +OnlineDDL show test_keyspace complete +OnlineDDL show test_keyspace failed +``` + +### Options + +``` + -h, --help help for show + --json Output JSON instead of human-readable table. + --limit uint Limit number of rows returned in output. + --order id Sort the results by id property of the Schema migration. (default "asc") + --skip uint Skip specified number of rows returned in output. +``` + +### 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). +