Skip to content

Update all client reference docs for all Vitess versions #1724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattlord merged 1 commit into from
Apr 9, 2024
Merged

Update all client reference docs for all Vitess versions #1724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/mysqlctl/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: mysqlctl
series: mysqlctl
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## mysqlctl

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: init
series: mysqlctl
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## mysqlctl init

Expand Down Expand Up @@ -44,7 +44,7 @@ mysqlctl \
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/vitess])
--config-path strings Paths to search for config files in. (default [<WORKDIR>])
--config-persistence-min-interval duration minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
--config-type string Config file type (omit to infer config type from file extension).
--db-credentials-file string db credentials file; send SIGHUP to reload this file
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: init config
series: mysqlctl
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## mysqlctl init_config

Expand Down Expand Up @@ -42,7 +42,7 @@ mysqlctl \
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/vitess])
--config-path strings Paths to search for config files in. (default [<WORKDIR>])
--config-persistence-min-interval duration minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
--config-type string Config file type (omit to infer config type from file extension).
--db-credentials-file string db credentials file; send SIGHUP to reload this file
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: position
series: mysqlctl
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## mysqlctl position

Expand All @@ -27,7 +27,7 @@ mysqlctl position <operation> <pos1> <pos2 | gtid> [flags]
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/vitess])
--config-path strings Paths to search for config files in. (default [<WORKDIR>])
--config-persistence-min-interval duration minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
--config-type string Config file type (omit to infer config type from file extension).
--db-credentials-file string db credentials file; send SIGHUP to reload this file
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: reinit config
series: mysqlctl
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## mysqlctl reinit_config

Expand Down Expand Up @@ -42,7 +42,7 @@ mysqlctl \
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/vitess])
--config-path strings Paths to search for config files in. (default [<WORKDIR>])
--config-persistence-min-interval duration minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
--config-type string Config file type (omit to infer config type from file extension).
--db-credentials-file string db credentials file; send SIGHUP to reload this file
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: shutdown
series: mysqlctl
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## mysqlctl shutdown

Expand Down Expand Up @@ -40,7 +40,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr shutdown
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/vitess])
--config-path strings Paths to search for config files in. (default [<WORKDIR>])
--config-persistence-min-interval duration minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
--config-type string Config file type (omit to infer config type from file extension).
--db-credentials-file string db credentials file; send SIGHUP to reload this file
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: start
series: mysqlctl
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## mysqlctl start

Expand Down Expand Up @@ -39,7 +39,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr start
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/vitess])
--config-path strings Paths to search for config files in. (default [<WORKDIR>])
--config-persistence-min-interval duration minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
--config-type string Config file type (omit to infer config type from file extension).
--db-credentials-file string db credentials file; send SIGHUP to reload this file
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: teardown
series: mysqlctl
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## mysqlctl teardown

Expand Down Expand Up @@ -43,7 +43,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr teardown
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/vitess])
--config-path strings Paths to search for config files in. (default [<WORKDIR>])
--config-persistence-min-interval duration minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
--config-type string Config file type (omit to infer config type from file extension).
--db-credentials-file string db credentials file; send SIGHUP to reload this file
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/mysqlctld/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: mysqlctld
series: mysqlctld
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## mysqlctld

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/topo2topo/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: topo2topo
series: topo2topo
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## topo2topo

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/vtaclcheck/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtaclcheck
series: vtaclcheck
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vtaclcheck

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vtbackup/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtbackup
series: vtbackup
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vtbackup

Expand Down Expand Up @@ -218,7 +218,7 @@ vtbackup [flags]
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--tablet_manager_grpc_ca string the server ca to use to validate servers when connecting
--tablet_manager_grpc_cert string the cert to use to connect
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8)
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8)
--tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100)
--tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting
--tablet_manager_grpc_key string the key to use to connect
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/vtclient/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtclient
series: vtclient
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vtclient

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vtcombo/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtcombo
series: vtcombo
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vtcombo

Expand Down Expand Up @@ -354,7 +354,7 @@ vtcombo [flags]
--tablet_hostname string if not empty, this hostname will be assumed instead of trying to resolve it
--tablet_manager_grpc_ca string the server ca to use to validate servers when connecting
--tablet_manager_grpc_cert string the cert to use to connect
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8)
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8)
--tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100)
--tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting
--tablet_manager_grpc_key string the key to use to connect
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vtctld/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtctld
series: vtctld
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vtctld

Expand Down Expand Up @@ -154,7 +154,7 @@ vtctld \
--tablet_health_keep_alive duration close streaming tablet health connection if there are no requests for this long (default 5m0s)
--tablet_manager_grpc_ca string the server ca to use to validate servers when connecting
--tablet_manager_grpc_cert string the cert to use to connect
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8)
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8)
--tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100)
--tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting
--tablet_manager_grpc_key string the key to use to connect
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/vtgate/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtgate
series: vtgate
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vtgate

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/vtgateclienttest/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtgateclienttest
series: vtgateclienttest
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vtgateclienttest

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vtorc/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtorc
series: vtorc
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vtorc

Expand Down Expand Up @@ -93,7 +93,7 @@ vtorc \
--table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class
--tablet_manager_grpc_ca string the server ca to use to validate servers when connecting
--tablet_manager_grpc_cert string the cert to use to connect
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8)
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8)
--tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100)
--tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting
--tablet_manager_grpc_key string the key to use to connect
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vttablet/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vttablet
series: vttablet
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vttablet

Expand Down Expand Up @@ -365,7 +365,7 @@ vttablet \
--tablet_hostname string if not empty, this hostname will be assumed instead of trying to resolve it
--tablet_manager_grpc_ca string the server ca to use to validate servers when connecting
--tablet_manager_grpc_cert string the cert to use to connect
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8)
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8)
--tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100)
--tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting
--tablet_manager_grpc_key string the key to use to connect
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vttestserver/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vttestserver
series: vttestserver
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vttestserver

Expand Down Expand Up @@ -128,7 +128,7 @@ vttestserver [flags]
--tablet_hostname string The hostname to use for the tablet otherwise it will be derived from OS' hostname (default "localhost")
--tablet_manager_grpc_ca string the server ca to use to validate servers when connecting
--tablet_manager_grpc_cert string the cert to use to connect
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8)
--tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8)
--tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100)
--tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting
--tablet_manager_grpc_key string the key to use to connect
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/vttlstest/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vttlstest
series: vttlstest
commit: b089f78945653f6acd17c66f896820e36df49437
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vttlstest

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/vttlstest/vttlstest_CreateCA.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateCA
series: vttlstest
commit: b089f78945653f6acd17c66f896820e36df49437
commit: b5b3114ab9371f882762dd66ae0efc5af3a3dbc0
---
## vttlstest CreateCA

Expand Down
Loading