Skip to content

Commit

Permalink
Generate cobradocs preview against planetscale/vitess:rohit/movetable…
Browse files Browse the repository at this point in the history
…s-filter
  • Loading branch information
vitess-bot[bot] authored Feb 7, 2024
1 parent 2b57ebf commit 39426e7
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtctldclient
series: vtctldclient
commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9
commit: bc375b8bdd97420a02e4a12129f969a59b7b3eed
---
## vtctldclient

Expand Down Expand Up @@ -35,6 +35,7 @@ vtctldclient [flags]

* [vtctldclient AddCellInfo](./vtctldclient_addcellinfo/) - Registers a local topology service in a new cell by creating the CellInfo.
* [vtctldclient AddCellsAlias](./vtctldclient_addcellsalias/) - Defines a group of cells that can be referenced by a single name (the alias).
* [vtctldclient ApplyKeyspaceRoutingRules](./vtctldclient_applykeyspaceroutingrules/) - Applies the provided keyspace routing rules.
* [vtctldclient ApplyRoutingRules](./vtctldclient_applyroutingrules/) - Applies the VSchema routing rules.
* [vtctldclient ApplySchema](./vtctldclient_applyschema/) - Applies the schema change to the specified keyspace on every primary, running in parallel on all shards. The changes are then propagated to replicas via replication.
* [vtctldclient ApplyShardRoutingRules](./vtctldclient_applyshardroutingrules/) - Applies the provided shard routing rules.
Expand Down Expand Up @@ -62,6 +63,7 @@ vtctldclient [flags]
* [vtctldclient GetCellsAliases](./vtctldclient_getcellsaliases/) - Gets all CellsAlias objects in the cluster.
* [vtctldclient GetFullStatus](./vtctldclient_getfullstatus/) - Outputs a JSON structure that contains full status of MySQL including the replication information, semi-sync information, GTID information among others.
* [vtctldclient GetKeyspace](./vtctldclient_getkeyspace/) - Returns information about the given keyspace from the topology.
* [vtctldclient GetKeyspaceRoutingRules](./vtctldclient_getkeyspaceroutingrules/) - Displays the currently active keyspace routing rules as a JSON document.
* [vtctldclient GetKeyspaces](./vtctldclient_getkeyspaces/) - Returns information about every keyspace in the topology.
* [vtctldclient GetPermissions](./vtctldclient_getpermissions/) - Displays the permissions for a tablet.
* [vtctldclient GetRoutingRules](./vtctldclient_getroutingrules/) - Displays the VSchema routing rules.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: ApplyKeyspaceRoutingRules
series: vtctldclient
commit: bc375b8bdd97420a02e4a12129f969a59b7b3eed
---
## vtctldclient ApplyKeyspaceRoutingRules

Applies the provided keyspace routing rules.

```
vtctldclient ApplyKeyspaceRoutingRules {--rules RULES | --rules-file RULES_FILE} [--cells=c1,c2,...] [--skip-rebuild] [--dry-run]
```

### Options

```
-c, --cells strings Limit the VSchema graph rebuilding to the specified cells. Ignored if --skip-rebuild is specified.
-d, --dry-run Validate the specified shard routing rules and note actions that would be taken, but do not actually apply the rules to the topo.
-h, --help help for ApplyKeyspaceRoutingRules
-r, --rules string Shard routing rules, specified as a string
-f, --rules-file string Path to a file containing shard routing rules specified as JSON
--skip-rebuild Skip rebuilding the SrvVSchema objects.
```

### Options inherited from parent commands

```
--action_timeout duration timeout to use for the command (default 1h0m0s)
--compact use compact format for otherwise verbose outputs
--server string server to use for the connection (required)
--topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global")
--topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379])
--topo-implementation string the topology implementation to use (default "etcd2")
```

### SEE ALSO

* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server.

Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: GetKeyspaceRoutingRules
series: vtctldclient
commit: bc375b8bdd97420a02e4a12129f969a59b7b3eed
---
## vtctldclient GetKeyspaceRoutingRules

Displays the currently active keyspace routing rules as a JSON document.

### Synopsis

Displays the currently active keyspace routing rules as a JSON document.

```
vtctldclient GetKeyspaceRoutingRules
```

### Options

```
-h, --help help for GetKeyspaceRoutingRules
```

### Options inherited from parent commands

```
--action_timeout duration timeout to use for the command (default 1h0m0s)
--compact use compact format for otherwise verbose outputs
--server string server to use for the connection (required)
--topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global")
--topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379])
--topo-implementation string the topology implementation to use (default "etcd2")
```

### SEE ALSO

* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: MoveTables create
series: vtctldclient
commit: f31f06475f2d0e8ea57a96d514c1a62298b1331d
commit: bc375b8bdd97420a02e4a12129f969a59b7b3eed
---
## vtctldclient MoveTables create

Expand All @@ -20,6 +20,7 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
### Options

```
--additional-filter string Additional filter to apply to the tables being copied in addition to the default filter.
-a, --all-cells Copy table data from any existing cell.
--all-tables Copy all tables from the source.
--atomic-copy (EXPERIMENTAL) A single copy phase is run for all tables from the source. Use this, for example, if your source keyspace has tables which use foreign key constraints.
Expand Down

0 comments on commit 39426e7

Please sign in to comment.