vtctl Cell Command Reference

The following vtctl commands are available for administering Cells.

Commands

AddCellInfo

Registers a local topology service in a new cell by creating the CellInfo with the provided parameters. The address will be used to connect to the topology service, and we’ll put Vitess data starting at the provided root.

Example

AddCellInfo [-server_address <addr>] [-root <root>] <cell>

Flags

NameTypeDefinition
rootstringThe root path the topology service is using for that cell.
server_addressstringThe address the topology service is using for that cell.

Arguments

  • <addr> – Required.
  • <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.

Errors

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

DeleteCellInfo

Deletes the CellInfo for the provided cell. The cell cannot be referenced by any Shard record.

Example

DeleteCellInfo <cell>

Errors

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

GetCellInfo

Prints a JSON representation of the CellInfo for a cell.

Example

GetCellInfo <cell>

Errors

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

GetCellInfoNames

Lists all the cells for which we have a CellInfo object, meaning we have a local topology service registered.

Example

GetCellInfoNames 

Errors

  • <GetCellInfoNames> command takes no parameter This error occurs if the command is not called with exactly 0 arguments.

UpdateCellInfo

Updates the content of a CellInfo with the provided parameters. If a value is empty, it is not updated. The CellInfo will be created if it doesn’t exist.

Example

UpdateCellInfo [-server_address <addr>] [-root <root>] <cell>

Flags

NameTypeDefinition
rootstringThe root path the topology service is using for that cell.
server_addressstringThe address the topology service is using for that cell.

Arguments

  • <addr> – Required.
  • <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.

Errors

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

GetCellInfo

Prints a JSON representation of the CellInfo for a cell.

Example

GetCellInfo <cell>

Errors

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

See Also