Skip to content

Commit

Permalink
vtctl: Update help text for "SetShardServedTypes" command.
Browse files Browse the repository at this point in the history
- Mentioned parameters "cells" and "remove".
- Clarified that it's an emergency function.
- Changed example from multiple to a single served type.
  • Loading branch information
michael-berlin committed Oct 4, 2016
1 parent f6ed050 commit e08f78a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions doc/vtctlReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1579,11 +1579,11 @@ Removes the cell from the shard's Cells list.

### SetShardServedTypes

Sets a given shard's served tablet types. Does not rebuild any serving graph.
Add or remove served type to/from a shard. This is meant as an emergency function. It does not rebuild any serving graph i.e. does not run 'RebuildKeyspaceGraph'.

#### Example

<pre class="command-example">SetShardServedTypes &lt;keyspace/shard&gt; [&lt;served tablet type1&gt;,&lt;served tablet type2&gt;,...]</pre>
<pre class="command-example">SetShardServedTypes [--cells=c1,c2,...] [--remove] &lt;keyspace/shard&gt; &lt;served tablet type&gt;</pre>

#### Flags

Expand All @@ -1596,7 +1596,7 @@ Sets a given shard's served tablet types. Does not rebuild any serving graph.
#### Arguments

* <code>&lt;keyspace/shard&gt;</code> &ndash; Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitepace, while the shard is typically identified by a string in the format <code>&lt;range start&gt;-&lt;range end&gt;</code>.
* <code>&lt;served tablet type&gt;</code> &ndash; Optional. The vttablet's role. Valid values are:
* <code>&lt;served tablet type&gt;</code> &ndash; Required. The vttablet's role. Valid values are:

* <code>backup</code> &ndash; A slaved copy of data that is offline to queries other than for backup purposes
* <code>batch</code> &ndash; A slaved copy of data for OLAP load patterns (typically for MapReduce jobs)
Expand Down
4 changes: 2 additions & 2 deletions go/vt/vtctl/vtctl.go
Original file line number Diff line number Diff line change
Expand Up @@ -217,8 +217,8 @@ var commands = []commandGroup{
"<keyspace/shard>",
"Lists all tablets in the specified shard."},
{"SetShardServedTypes", commandSetShardServedTypes,
"<keyspace/shard> [<served tablet type1>,<served tablet type2>,...]",
"Sets a given shard's served tablet types. Does not rebuild any serving graph."},
"[--cells=c1,c2,...] [--remove] <keyspace/shard> <served tablet type>",
"Add or remove served type to/from a shard. This is meant as an emergency function. It does not rebuild any serving graph i.e. does not run 'RebuildKeyspaceGraph'."},
{"SetShardTabletControl", commandSetShardTabletControl,
"[--cells=c1,c2,...] [--blacklisted_tables=t1,t2,...] [--remove] [--disable_query_service] <keyspace/shard> <tablet type>",
"Sets the TabletControl record for a shard and type. Only use this for an emergency fix or after a finished vertical split. The *MigrateServedFrom* and *MigrateServedType* commands set this field appropriately already. Always specify the blacklisted_tables flag for vertical splits, but never for horizontal splits."},
Expand Down

0 comments on commit e08f78a

Please sign in to comment.