Document vitessio/vitess#12915 (vitessio#1446)

* Document vitessio/vitess#12915 Signed-off-by: Matt Lord <[email protected]> * Update help after PR changes Signed-off-by: Matt Lord <[email protected]> * More updates/corrections based on PR changes Signed-off-by: Matt Lord <[email protected]> --------- Signed-off-by: Matt Lord <[email protected]>
ejortegau · Apr 18, 2023 · 0fa6130 · 0fa6130
1 parent e050e3c
commit 0fa6130
Showing 1 changed file with 15 additions and 10 deletions.
diff --git a/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_GetTablets.md b/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_GetTablets.md
@@ -10,33 +10,38 @@ Looks up tablets according to filter criteria.
 
 Looks up tablets according to the filter criteria.
 
-If --tablet-alias is passed, none of the other filters (keyspace, shard, cell) may
-be passed, and tablets are looked up by tablet alias only.
+If --tablet-alias is passed, none of the other filters (tablet-type, keyspace,
+shard, cell) may be passed, and tablets are looked up by tablet alias only.
 
 If --keyspace is passed, then all tablets in the keyspace are retrieved. The
 --shard flag may also be passed to further narrow the set of tablets to that
 <keyspace/shard>. Passing --shard without also passing --keyspace will fail.
 
+If --tablet-type is passed, only tablets of the specified type will be
+returned. Valid tablet types are:
+"backup", "drained", "experimental", "primary", "rdonly", "replica", "restore", "spare".
+
 Passing --cell limits the set of tablets to those in the specified cells. The
 --cell flag accepts a CSV argument (e.g. --cell "c1,c2") and may be repeated
 (e.g. --cell "c1" --cell "c2").
 
 Valid output formats are "awk" and "json".
 
 ```
-vtctldclient GetTablets [--strict] [{--cell $c1 [--cell $c2 ...], --keyspace $ks [--shard $shard], --tablet-alias $alias}]
+vtctldclient GetTablets [--strict] [{--cell $c1 [--cell $c2 ...] [--tablet-type $t1] [--keyspace $ks [--shard $shard]], --tablet-alias $alias}]
 ```
 
 ### Options
 
 ```
-  -c, --cell strings           List of cells to filter tablets by.
-      --format string          Output format to use; valid choices are (json, awk). (default "awk")
-  -h, --help                   help for GetTablets
-  -k, --keyspace string        Keyspace to filter tablets by.
-  -s, --shard string           Shard to filter tablets by.
-      --strict                 Require all cells to return successful tablet data. Without --strict, tablet listings may be partial.
-  -t, --tablet-alias strings   List of tablet aliases to filter by.
+  -c, --cell strings                        List of cells to filter tablets by.
+      --format string                       Output format to use; valid choices are (json, awk). (default "awk")
+  -h, --help                                help for GetTablets
+  -k, --keyspace string                     Keyspace to filter tablets by.
+  -s, --shard string                        Shard to filter tablets by.
+      --strict                              Require all cells to return successful tablet data. Without --strict, tablet listings may be partial.
+  -t, --tablet-alias strings                List of tablet aliases to filter by.
+      --tablet-type topodatapb.TabletType   Tablet type to filter by (e.g. primary or replica). (default UNKNOWN)
 ```
 
 ### Options inherited from parent commands