The Vitess Docs | vtctl Serving Graph Command Reference

This is the documentation for Vitess v16.0, an older release. See the v24.0 documentation for the latest release.

vtctl Serving Graph Command Reference

The following vtctl commands are available for administering the Serving Graph.

Commands #

Outputs a list of keyspace names.

GetSrvKeyspaceNames <cell>

<cell> – 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.

the <cell> argument is required for the <GetSrvKeyspaceNames> command This error occurs if the command is not called with exactly one argument.

Outputs a JSON structure that contains information about the SrvKeyspace.

GetSrvKeyspace <cell> <keyspace>

<cell> – 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.
<keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace.

the <cell> and <keyspace> arguments are required for the <GetSrvKeyspace> command This error occurs if the command is not called with exactly 2 arguments.

Outputs a JSON structure that contains information about the SrvVSchema.

GetSrvVSchema <cell>

<cell> – 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.

the <cell> argument is required for the <GetSrvVSchema> command This error occurs if the command is not called with exactly one argument.

DeleteSrvVSchema  <cell>