vtctl Generic Command Reference
The following generic vtctl commands are available for administering Vitess.
Commands #
Validate #
Validates that all nodes reachable from the global replication graph and that all tablets in all discoverable cells are consistent.
Example #
Validate [-ping-tablets]
Flags #
| Name | Type | Definition |
|---|---|---|
| ping-tablets | Boolean | Indicates whether all tablets should be pinged during the validation process |
ListAllTablets #
Lists all tablets in an awk-friendly way.
Example #
ListAllTablets <cell name>
Arguments #
<cell name>β Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms “cell” and “data center” are interchangeable. The argument value is a string that does not contain whitespace.
Errors #
- the
<cell name>argument is required for the<ListAllTablets>command This error occurs if the command is not called with exactly one argument.
ListTablets #
Lists specified tablets in an awk-friendly way.
Example #
ListTablets <tablet alias> ...
Arguments #
<tablet alias>β Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format<cell name>-<uid>. To specify multiple values for this argument, separate individual values with a space.
Errors #
- the
<tablet alias>argument is required for the<ListTablets>command This error occurs if the command is not called with at least one argument.
Help #
Provides help for a command.
Example #
Help [command name]