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 158f5e0 commit 6e85c56
Show file tree
Hide file tree
Showing 4 changed files with 84 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: 0b7b61403f3df520f0274f1f8376979725abfaae
---
## 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: 0b7b61403f3df520f0274f1f8376979725abfaae
---
## 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: 0b7b61403f3df520f0274f1f8376979725abfaae
---
## 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: 574162f4cad770c19a20a28526fe46f7de24b999
commit: 0b7b61403f3df520f0274f1f8376979725abfaae
---
## 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 All @@ -31,12 +32,14 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
--no-routing-rules (Advanced) Do not create routing rules while creating the workflow. See the reference documentation for limitations if you use this flag.
--on-ddl string What to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE. (default "IGNORE")
--source-keyspace string Keyspace where the tables are being moved from.
--source-keyspace-alias string Used in conjunction with --use-keyspace-routing-rules. This value will be used instead of the source keyspace name in the keyspace routing rules.
--source-shards strings Source shards to copy data from when performing a partial MoveTables (experimental).
--source-time-zone string Specifying this causes any DATETIME fields to be converted from the given time zone into UTC.
--stop-after-copy Stop the workflow after it's finished copying the existing rows and before it starts replicating changes.
--tables strings Source tables to copy.
--tablet-types strings Source tablet types to replicate table data from (e.g. PRIMARY,REPLICA,RDONLY).
--tablet-types-in-preference-order When performing source tablet selection, look for candidates in the type order as they are listed in the tablet-types flag. (default true)
--use-keyspace-routing-rules Use keyspaces routing rules to route traffic to the target keyspace. This is not compatible with the --no-routing-rules flag and will override the default table routing rules mechanism.
```

### Options inherited from parent commands
Expand Down

0 comments on commit 6e85c56

Please sign in to comment.