vtctl Keyspace Command Reference

The following vtctl commands are available for administering Keyspaces.

Commands

CreateKeyspace

Creates the specified keyspace.

Example

1. CreateKeyspace -- [--sharding_column_name=name] [--sharding_column_type=type] [--served_from=tablettype1:ks1,tablettype2:ks2,...] [--force] [--keyspace_type=type] [--base_keyspace=base_keyspace] [--snapshot_time=time] [--durability-policy=policy_name] [--sidecar-db-name=db_name] <keyspace name>

Flags

Arguments

• <keyspace name> – 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.

Errors

• the <keyspace name> argument is required for the <CreateKeyspace> command This error occurs if the command is not called with exactly one argument.

DeleteKeyspace

Deletes the specified keyspace. In recursive mode, it also recursively deletes all shards in the keyspace. Otherwise, there must be no shards left in the keyspace.

Example

1. DeleteKeyspace -- [--recursive] <keyspace>
2. Deletes the specified keyspace. In recursive mode, it also recursively deletes all shards in the keyspace. Otherwise, there must be no shards left in the keyspace.

Flags

Arguments

• <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.

Errors

• must specify the <keyspace> argument for <DeleteKeyspace> This error occurs if the command is not called with exactly one argument.

RemoveKeyspaceCell

Removes the cell from the Cells list for all shards in the keyspace, and the SrvKeyspace for that keyspace in that cell.

Example

1. RemoveKeyspaceCell -- [--force] [--recursive] <keyspace> <cell>
2. Removes the cell from the Cells list for all shards in the keyspace, and the SrvKeyspace for that keyspace in that cell.

Flags

Arguments

• <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.
• <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 <keyspace> and <cell> arguments are required for the <RemoveKeyspaceCell> command This error occurs if the command is not called with exactly 2 arguments.

GetKeyspace

Outputs a JSON structure that contains information about the Keyspace.

Example

1. GetKeyspace <keyspace>
2. Outputs a JSON structure that contains information about the Keyspace.

Arguments

• <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.

Errors

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

GetKeyspaces

Outputs a sorted list of all keyspaces.

RebuildKeyspaceGraph

Rebuilds the serving data for the keyspace. This command may trigger an update to all connected clients.

Example

1. RebuildKeyspaceGraph -- [--cells=c1,c2,...] [--allow_partial] <keyspace> ...
2. Rebuilds the serving data for the keyspace. This command may trigger an update to all connected clients.

Flags

Arguments

• <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. To specify multiple values for this argument, separate individual values with a space.

Errors

• the <keyspace> argument must be used to specify at least one keyspace when calling the <RebuildKeyspaceGraph> command This error occurs if the command is not called with at least one argument.

ValidateKeyspace

Validates that all nodes reachable from the specified keyspace are consistent.

Example

1. ValidateKeyspace -- [--ping-tablets] <keyspace name>
2. Validates that all nodes reachable from the specified keyspace are consistent.

Flags

Arguments

• <keyspace name> – 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.

Errors

• the <keyspace name> argument is required for the <ValidateKeyspace> command This error occurs if the command is not called with exactly one argument.

FindAllShardsInKeyspace

Displays all of the shards in the specified keyspace.

Example

1. FindAllShardsInKeyspace <keyspace>
2. Displays all of the shards in the specified keyspace.

Arguments

• <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.

Errors

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

Reshard

Start a Resharding process. Example: Reshard —cells=’zone1,alias1’ —tablet_types=’PRIMARY,REPLICA,RDONLY’ ks.workflow001 — ‘0’ ‘-80,80-‘

Example

1. Reshard -- [--source_shards=<source_shards>] [--target_shards=<target_shards>] [--cells=<cells>] [--tablet_types=<source_tablet_types>] [--on-ddl=<ddl-action>] [--skip_schema_copy] <action> <keyspace.workflow>

Flags

Arguments

• <action> - Required. Action must be one of the following: Create, Complete, Cancel, SwitchTraffic, ReverseTrafffic, Show, or Progress.
• <keyspace.workflow> - Required. The name of the keyspace and workflow to be used for the resharding process. The argument value must be a string that does not contain whitespace.

MoveTables

Move table(s) to another keyspace, table_specs is a list of tables or the tables section of the vschema for the target keyspace. Example:

1. {
2. "t1": {"column_vindexes": [{"column": "id1", "name": "hash"}]},
3. "t2": {"column_vindexes": [{"column": "id2", "name": "hash"}]}
4. }

In the case of an unsharded target keyspace the vschema for each table may be empty. Example:

1. {
2. "t1":{},
3. "t2":{}
4. }

Example

1. MoveTables [--source=<sourceKs>] [--tables=<tableSpecs>] [--cells=<cells>] [--tablet_types=<source_tablet_types>] [--all] [--exclude=<tables>] [--auto_start] [--stop_after_copy] [--on-ddl=<ddl-action>] [--source_shards=<source_shards>] <action> <targetKs.workflow>

Flags

Arguments

• <action> - Required. Action must be one of the following: Create, Complete, Cancel, SwitchTraffic, ReverseTrafffic, Show, or Progress.
• <keyspace.workflow> - Required. The name of the keyspace and workflow to be used for the resharding process. The argument value must be a string that does not contain whitespace.

CreateLookupVindex

Create and backfill a lookup vindex. the json_spec must contain the vindex and colvindex specs for the new lookup.

Example

1. CreateLookupVindex  -- [--cells=<source_cells>] [--continue_after_copy_with_owner=false] [--tablet_types=<source_tablet_types>] <keyspace> <json_spec>
2. Create and backfill a lookup vindex. the json_spec must contain the vindex and colvindex specs for the new lookup.

Flags

Arguments

• <keyspace> - Required. The name of the keyspace where lookup vindex needs to be created.
• <json_spec> - Required. json specification about how to create the lookup vindex. More information in user-guides

ExternalizeVindex

Externalize (activate) a lookup vindex backfilled using CreateLookupVindex.

This removes the workflow and vreplication streams associated with the backfill, and clears the write_only flag on the vindex. After this flag is removed, applications can start using the vindex for lookups.

Example

1. ExternalizeVindex <keyspace>.<vindex>

Materialize

Performs materialization based on the json spec. Is used directly to form VReplication rules, with an optional step to copy table structure/DDL.

Example

1. Materialize -- [--cells=<cells>] [--tablet_types=<source_tablet_types>] <json_spec>

Flags

Argument

• <json_spec> - Required.

Example:

1. {
2. "workflow": "aaa",
3. "source_keyspace": "source",
4. "target_keyspace": "target",
5. "table_settings": [{
6. "target_table": "customer",
7. "source_expression": "select * from customer",
8. "create_ddl": "copy"}]
9. }

VDiff

Perform a diff of all tables in the workflow

Example

1. VDiff -- [--source_cell=<cell>] [--target_cell=<cell>] [--tablet_types=in_order:RDONLY,REPLICA,PRIMARY] [--limit=<max rows to diff>] [--tables=<table list>] [--format=json] [--auto-retry] [--verbose] [--max_extra_rows_to_compare=1000] [--filtered_replication_wait_time=30s] [--debug_query] [--only_pks] [--wait] [--wait-update-interval=1m] <keyspace.workflow> [<action>] [<UUID>]

Flags

See Also

• vtctl command index