vtctl Cell Aliases Command Reference

The following vtctl commands are available for administering Cell Aliases.

Commands #

AddCellsAlias #

Defines a group of cells within which replica/rdonly traffic can be routed across cells. By default, Vitess does not allow traffic between replicas that are part of different cells. Between cells that are not in the same group (alias), only primary traffic can be routed.

Example #

AddCellsAlias [-cells <cell1,cell2,cell3>] <alias>

Flags #

NameTypeDefinition
cellsstringThe list of cell names that are members of this alias.

Arguments #

  • <alias> – Required. Alias name for this grouping.

Errors #

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

UpdateCellsAlias #

Updates the content of a CellAlias with the provided parameters. Empty values and intersections with other aliases are not supported.

Example #

UpdateCellsAliases [-cells <cell1,cell2,cell3>] <alias>

Flags #

NameTypeDefinition
cellsstringThe list of cell names that are members of this alias.

Arguments #

  • <alias> – Required. Alias name group to update.

Errors #

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

DeleteCellsAlias #

Deletes the CellsAlias for the provided alias. After deleting an alias, cells that were part of the group are not going to be able to route replica/rdonly traffic to the rest of the cells that were part of the grouping.

Example #

DeleteCellsAlias <alias>

Errors #

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

GetCellsAliases #

Fetches in json format all the existent cells alias groups.

Example #

GetCellsAliases

See Also #

vtctl Cell Aliases Command Reference