Skip to content

Commit

Permalink
update longhelp for vtgate
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Mason <[email protected]>
  • Loading branch information
Andrew Mason committed Sep 13, 2023
1 parent 3b42221 commit c7da66d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
9 changes: 7 additions & 2 deletions go/cmd/vtgate/cli/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,13 @@ var (
Main = &cobra.Command{
Use: "vtgate",
Short: "VTGate is a stateless proxy responsible for accepting requests from applications and routing them to the appropriate tablet server(s) for query execution. It speaks both the MySQL Protocol and a gRPC protocol.",
Example: `
vtgate \
Long: `VTGate is a stateless proxy responsible for accepting requests from applications and routing them to the appropriate tablet server(s) for query execution. It speaks both the MySQL Protocol and a gRPC protocol.
### Key Options
` +
"`--srv_topo_cache_ttl`: There may be instances where you will need to increase the cached TTL from the default of 1 second to a higher number:\n" +
`* You may want to increase this option if you see that your topo leader goes down and keeps your queries waiting for a few seconds.`,
Example: `vtgate \
--topo_implementation etcd2 \
--topo_global_server_address localhost:2379 \
--topo_global_root /vitess/global \
Expand Down
8 changes: 7 additions & 1 deletion go/flags/endtoend/vtgate.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
VTGate is a stateless proxy responsible for accepting requests from applications and routing them to the appropriate tablet server(s) for query execution. It speaks both the MySQL Protocol and a gRPC protocol.
VTGate is a stateless proxy responsible for accepting requests from applications and routing them to the appropriate tablet server(s) for query execution.
It speaks both the MySQL Protocol and a gRPC protocol.

### Key Options

* `--srv_topo_cache_ttl`: There may be instances where you will need to increase the cached TTL from the default of 1 second to a higher number:
* You may want to increase this option if you see that your topo leader goes down and keeps your queries waiting for a few seconds.

Usage:
vtgate [flags]
Expand Down

0 comments on commit c7da66d

Please sign in to comment.